Expense-Tracker
An expense tracker built with FARM stack (FastAPI,React,MongoDB)
Requirements
- Docker
- Docker-Compose
Install and Run
To install and run the application, use docker-compose as given below:
-
Build: To build the application (api+frontend+db):docker-compose up -d --build -
Delete or Remove: To delete or remove the containers (api+frontend+db):docker-compose down
A demo CLI after running
docker-compose
Shut application
Running Containers
Environments
There are two environments as of now, development and production
Development:
-
Build:
docker-compose up -d --build
To make this command easier using Makefile:
make compose_up
-
Delete or Remove:
docker-compose down
To make this command easier using Makefile:
make compose_down
Production:
-
Build: To build it for production usingreact-multistagebuilds andnginxdocker-compose -f docker-compose.prod.yml up -d --build
To make this command easier
make compose_prod_up
-
Delete or Remove: To remove the running containersdocker-compose -f docker-compose.prod.yml down
To make this command easier
make compose_prod_down
Architecture
The architecture of the backend is as follows:
- API Framework:
FastAPI - ORM (Object Relational Mapper):
Python Class Abstraction - API Query framework:
GraphQL - DB:
MongoDB - DB Driver:
Pymongo - Cache:
Redis - CI/CD:
Github Actions - Container:
Docker - Workflow:
Docker-Compose
Services and PORTS:
The services running are:
- api (
fastapi) - frontend (
react) - db (
mongodb)
The ports running these services on:
Development Env:
- api:
localhost:8000 - frontend:
localhost:3000 - db:
localhost:27017
Production Env:
- api:
localhost:8000 - frontend:
localhost:4000 - db:
localhost:27017
API Documentation:
Dashboard:
- Overall Dashboard: GET
/dashboard/all - Monthly Dashboard: GET
/dashboard/{month_name}
Transactions:
- All Transactions: GET
/transaction/all - Get Transaction by ID: GET
/transaction/{id} - Get Transactions by Month: GET
/transactions/{month} - Add a Transaction: POST
/transaction/add - Delete a Transaction by ID: DELETE
/transaction/{id} - Delete entire Table/Collection: DELETE
/transactions
60 Dec 29, 2022
10 Aug 17, 2022
3 Oct 24, 2022
121 Jan 2, 2023
2 Dec 15, 2022
21 Dec 5, 2022
16 Dec 30, 2022
34 Dec 28, 2022
14 Dec 16, 2022
2 Dec 25, 2021