Package Exports
- bookez_package
Readme
BookEz Npm-Package
A React component library and utilities for BookEz, including banking data tables, Plaid integration, and custom UI elements.
Features
- Banking Data Table: Categorize, review, and manage transactions.
- Plaid Integration: Securely connect and sync bank accounts.
- Custom UI Components: Dropdowns, dialogs, skeleton loaders, and more.
- React Hook Form Integration: Easy form management and validation.
- Context Providers: Manage banking and account state globally.
Getting Started
Prerequisites
- Node.js:
22.11.0
(see above) - npm: v9+ recommended
- React: v18+
Installation
Clone the repository:
git clone https://github.com/your-org/BookEz-Npm-Package.git
cd BookEz-Npm-Package
npm install
Usage
Import and use components in your React app:
import { BankingData } from "./src/pages/Banking/BankingData";
import { LinkedAccountProvider } from "./src/providers/LinkedAccountsProvider";
function App() {
return (
<LinkedAccountProvider>
<BankingData />
</LinkedAccountProvider>
);
}
Scripts
npm start
– Start the development servernpm run build
– Build the packagenpm test
– Run tests
Project Structure
src/
components/ # Reusable UI components
pages/Banking/ # Banking-related pages and logic
providers/ # React context providers
axios/ # API utilities
lib/ # Utility functions
Environment Variables
- Configure your API endpoints and Plaid keys as needed in your environment.
Contributing
- Fork the repo
- Create your feature branch (
git checkout -b feature/YourFeature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin feature/YourFeature
) - Open a pull request
License
MIT
Contact
For questions or support,