https://github.com/nikelaz/bw-ui

https://github.com/nikelaz/bw-ui

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nikelaz/bw-ui
• Owner: nikelaz
• Created: 2024-04-06T11:10:44.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-16T09:49:57.000Z (26 days ago)
• Last Synced: 2024-11-16T10:27:18.705Z (26 days ago)
• Language: TypeScript
• Size: 448 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - nikelaz/bw-ui - (TypeScript)

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

1. [**Software Architecture**](https://youtu.be/Z3OEsK2fUl8)

2. [**UI/UX Design**](https://youtu.be/D_TpsGgVdwY)

3. [**TypeORM Models and Validation**](https://youtu.be/BxH9NYMuTrU)

4. [**Fastify User Authentication with JWT**](https://youtu.be/vVF8Szpx8Ho)

5. [**RESTful Node.js Controllers with Fastify**](https://youtu.be/vgfkQX8VVEM)

6. [**Docker Dev Environment with DB, Server and Client**](https://youtu.be/Cco_uGFwJyg)

7. [**Tailwind CSS Theme Setup**](https://youtu.be/rm-XI9W0Mts)

8. [**Components Library with Vite & Storybook**](https://youtu.be/ESkD6Ouvs2s)

9. [**Form Components**](https://youtu.be/IrqcSSRCaTQ)

10. [**Table, Data Grid and Modal Dialog Components**](https://youtu.be/WmA_LGg4ywc)

11. [**Navigation and Dropdown Components**](https://youtu.be/0yYdZ0a9fP4)

## 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.