https://github.com/alysnnix/finch
Organize your accounts, track your spending, create budgets and achieve your financial goals more easily than ever.
https://github.com/alysnnix/finch
docker finance finch nestjs postgresql
Last synced: 3 months ago
JSON representation
Organize your accounts, track your spending, create budgets and achieve your financial goals more easily than ever.
- Host: GitHub
- URL: https://github.com/alysnnix/finch
- Owner: alysnnix
- License: gpl-3.0
- Created: 2024-07-22T20:27:42.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-09-28T02:14:41.000Z (almost 2 years ago)
- Last Synced: 2025-06-13T06:58:06.496Z (about 1 year ago)
- Topics: docker, finance, finch, nestjs, postgresql
- Language: TypeScript
- Homepage:
- Size: 2.06 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> 👷 Work in progress 👷
---
Finch - Personal finance control
## Tech stack
- [**Backend:**](./backend/README.md)
- [`Docker`](https://www.docker.com/)
- [`Nest.js`](https://nestjs.com/)
- [`Prisma ORM`](https://www.prisma.io/)
- `PostgreSQL`
- **Frontend:**
- [`React`](https://react.dev/)
- [`Radix Ui`](https://www.radix-ui.com/)
- [`React Query`](https://tanstack.com/)
- [`Tailwind CSS`](https://tailwindcss.com/)
## Running locally
### Database
1. To setup the database, make sure you have built the container and that it has uploaded both the database and the backend:
1.1 Follow steps 1 and 2 from the `backend` section.
2. If you structuring the database for the first time follow the steps below:
- 2.1. Enter inside the backend container:
```bash
docker compose exec -it finch-backend bash
```
- 2.2. Run the following command to create the database schema:
```bash
npx prisma migrate dev
```
- 2.3. Check if the database was structured correctly:
- 2.3.1. Run the following command to enter the database:
```bash
docker exec -it finch-db bash
```
- 2.3.2. Run the following command login in `psql`:
```bash
psql -U root
```
- 2.3.3. Run the following command to list the databases, you should see the `finch` database:
```bash
\l
```
- 2.3.4. Run the following command to list the tables, you should see all tables created by Prisma:
```bash
\c finch
\dt
```
if you see the tables, the database was structured correctly :>
### Backend
1. Create a `.env` file in the `backend` directory follow the `.env.example` file as a template.:
2. Run the following command to install the dependencies:
```bash
docker compose run --rm backend-deps
```
3. Run the following command to start the backend:
- 3.1. If you run the backend for the first time, run the following command:
```bash
docker compose up --build
```
- 3.2. If you have already run the backend before, run the following command:
```bash
docker compose up finch-backend finch-db
```
### Frontend
To run the frontend, follow the instructions below its similar to the backend:
1. Run the following command to install the dependencies:
```bash
docker compose run --rm frontend-deps
```
3. Run the following command to start the container:
- 3.1. If you run the backend for the first time, run the following command:
```bash
docker compose up --build
```
- 3.2. If you have already run the backend before, run the following command:
```bash
docker compose up finch-frontend
```
## Branding
😒 Tired of your finances being in ~~disorder~~?
⛓️💥 No more complicated spreadsheets and confusing apps!
🤩 With **Finch**, you have one hassle-free place for all your finances.
Organize your accounts, track your spending, create budgets and achieve your financial goals more easily than ever.