Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikelaz/bw-monorepo
https://github.com/nikelaz/bw-monorepo
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/nikelaz/bw-monorepo
- Owner: nikelaz
- Created: 2024-02-24T11:08:56.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-05T22:03:28.000Z (13 days ago)
- Last Synced: 2025-01-05T23:18:48.107Z (13 days ago)
- Language: JavaScript
- Size: 774 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - nikelaz/bw-monorepo - (JavaScript)
README
# Budget Warden Monorepo
## Summary
This is the monorepo for the Budget Warden project (a personal finance tracking application). This entire project is currently in progress and its development is documented in a YouTube series. If you are interested you can explore the videos in the list below:
### 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)
12. [**Next.js Authentication**](https://youtu.be/agxIP5OJCSs)
13. [**Web Client Architecture**](https://youtu.be/711b5jOOcNE)
## Submodules
This repository includes two submodules:
- [**bw-backend-service**](https://github.com/nikelaz/bw-backend-service)
- [**bw-web-client**](https://github.com/nikelaz/bw-web-client)
Make sure to pull with the recursive submodules option:
```
git pull --recurse-submodules
```
or
```
git submodule update --recursive
```
## Dependencies
This project contains Node.js submodules and a docker-compose.yml file for development. To develop and avoid syntax highlighting in most editors you still need to install the NPM dependencies locally. For that make sure you have Node.js installed. The recommended version is `22.x LTS`.
You will also need docker and docker-compose installed. On a Windows/Mac system you can just install [Docker Desktop](https://www.docker.com/products/docker-desktop/).
## Installation
To install all NPM dependencies locally just run:
```
npm install
```
The specified pre-install script will go into the directories of the submodules and run `npm install` locally. **Note!** if you haven't pulled the submodules this script fill fail! Check section **Submodules** for more details.
## Running
To run the docker-compose services you can use
```
docker-compose up
```
Currently the docker-compose.yml file is ONLY setup for development. The *bw-backend-service* and *bw-web-client* will watch for local changes and restart. Do not copy this setup for deployment in production!
## 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.