Finances-API is a REST API designed for personal financial management. It allows users to manage their finances efficiently by providing features like recording incomes and expenses, querying financial data, and access control using JWT authentication.
The project was developed in sprints lasting 1 week each, which had certain activities to be implemented. For better management of activities, trello was used.
- CRUD operations for financial records (income and expenses) using Spring Boot.
- Frontend developed using Angular for a dynamic and responsive user experience.
- AI integration for custom financial analysis with Spring AI.
- Secure access control using JWT authentication.
- Persistent data storage with PostgreSQL.
- Containerized for easy deployment using Docker.
- API documentation and testing support with Postman.
The Angular app is running on GitHub Pages and the Spring Boot API is running on a Google Cloud Virtual Machine, with DNS and HTTPS from Cloudflare.
The links to access are:
- Angular application https://marujo.site
- Spring Boot API https://finances.marujo.site
To run locally you need to have Docker installed.
- Clone project
git clone https://github.com/WesleyMime/Finances-API.git
- Enter the project folder
cd Finances-API
- Start services
docker compose up
Once the application is running, you can use the Angular app or use an API client like Postman to interact with the API. To use AI features, you will need an API Key. You can get one for free at https://groq.com/, after obtaining the key, change the AI_API_KEY param in docker-compose to it.
The links to access are:
- Angular application http://localhost
- Spring Boot API http://localhost:8080
The documentation made in Postman can be accessed by this link.
Distributed under the MIT license. See LICENSE.txt for more information.