https://github.com/wesgtox/financial-wellness-score
Find out your financial health status
https://github.com/wesgtox/financial-wellness-score
docker docker-compose fastapi pytest python react vitejs
Last synced: 3 months ago
JSON representation
Find out your financial health status
- Host: GitHub
- URL: https://github.com/wesgtox/financial-wellness-score
- Owner: WesGtoX
- License: mit
- Created: 2023-02-20T19:30:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-23T22:49:56.000Z (over 2 years ago)
- Last Synced: 2025-01-13T06:09:44.160Z (10 months ago)
- Topics: docker, docker-compose, fastapi, pytest, python, react, vitejs
- Language: TypeScript
- Homepage:
- Size: 68.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
About |
Technology |
Layout |
Getting Started |
Usage |
Roadmap |
License
# Financial Wellness Score
Financial Wellness Score is an application that shows the user their financial health.
## About the Project
Through the annual gross income and average monthly costs, the application can tell you if your financial health is going well or bad.
The statuses returned by the application are based on three types:
- `HEALTHY`: _Your financial health is very good, keep up the good work;_
- `MEDIUM`: _Attention! Your financial health is average, but there is room for improvement;_
- `LOW`: _Careful! Your financial health is not good._
## Technology
This project was developed with the following technologies:
- [Python](https://www.python.org/)
- [FastAPI](https://fastapi.tiangolo.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [React](https://pt-br.reactjs.org/)
- [Vite](https://vitejs.dev/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
## Layout
You can view the project layout in the format through this [LINK](https://www.figma.com/file/eysSLDJFaEgGRWqHTFVehu/Take-Home-Assignment-v3?node-id=0%3A1).
Remembering that you will need to have an account at [Figma](http://figma.com/).
## Getting Started
### Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
### Build and Run
1. Clone the repository:
```bash
git clone https://github.com/WesGtoX/financial-wellness-score.git
```
2. Build docker images:
```bash
make build
```
3. Run:
```bash
make run
```
4. Run backend tests:
```bash
make test
```
5. Access the api documentation through the link:
- http://0.0.0.0:8000/docs/
6. Access the web application through the link:
- http://localhost:5173/
## Usage
Once the project is running, the API documentation can be accessed through the following links:
- http://0.0.0.0:8000/docs/
- http://0.0.0.0:8000/redoc/
The web application can be accessed through the link:
- http://localhost:5173/
## Roadmap
- More information about the development process: [CHANGELOG](CHANGELOG.md)
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
---
Made with ♥ by [Wesley Mendes](https://wesleymendes.com/) :wave: