@nikelaz/bw-ui
v0.7.41
Published
<img src="https://i.imgur.com/lX2NzV2.png" alt="budget warden logo" width="320" height="81" style="margin-bottom: 10px;"/>
Downloads
168
Readme
Budget Warden UI
Summary
This package is the user interface components library for Budget Warden - a software application for budget tracking and planning that is currently under development. The development process is documented live as a YouTube series.
YouTube Series
- Software Architecture
- UI/UX Design
- TypeORM Models and Validation
- Fastify User Authentication with JWT
- RESTful Node.js Controllers with Fastify
- Docker Dev Environment with DB, Server and Client
- Tailwind CSS Theme Setup
- Components Library with Vite & Storybook
- Form Components
- Table, Data Grid and Modal Dialog Components
- Navigation and Dropdown Components
Dependencies
This is a Node.js application (Next.js). The recommended Node.js version to run it is 20.11.1 LTS
.
Installation
To install all dependencies just run:
npm install
Scripts
| Script | Description |
|-|-|
| build
| Builds the project |
| dev
| Development mode |
| storybook
| Runs the storybook in development mode |
Contributing
At this stage pull requests/contributions will not be accepted, as the project is being developed as part of a YouTube series and there is a strict plan by which the initial development will be done. If you wish to suggest changes during this stage you can leave a comment in one of the YouTube videos.
After the YouTube series is finished the repository will be open for contributions and I will update the guidelines.