FinTrack API is a RESTful web service designed for personal finance tracking. It provides endpoints to manage user accounts, financial categories, transactions, and finance types.
FinTrack API offers a convenient way to track personal finances, categorize transactions, and manage user accounts. Built with FastAPI, it ensures high performance and scalability.
Manage personal finances effortlessly with FinTrack API. Add users, categorize transactions, and track financial data seamlessly. Explore the comprehensive documentation for detailed instructions on using each endpoint.
The API provides the following endpoints:
/health/heartbeat: Check the health status of the API./user/add: Add a new user./user/login: User login authentication./user/get: Get user details by email ID./category/add: Add a new financial category./category/update: Update an existing financial category./category/get: Get all financial categories./category/get/{category_id}: Get a specific financial category by ID./category/delete/{category_id}: Delete a financial category by ID./transaction/add: Add a new transaction./transaction/update: Update an existing transaction./transaction/get: Get all transactions./transaction/get/{transaction_id}: Get a specific transaction by ID./transaction/delete/{transaction_id}: Delete a transaction by ID./fin_type/get_all: Get all finance types.
- Clone the repository:
git clone https://github.com/your/repository.git - Navigate to the project directory:
cd repository - Build and run the Docker containers:
docker-compose up --buildThis command will build the Docker image and start the containers defined in the docker-compose.yml file.
The API will be accessible at http://localhost:8000.
For detailed API documentation, visit the Swagger UI endpoint at http://localhost:8000/docs after running the Docker containers.
Contributions are welcome! Feel free to submit bug reports, feature requests, or pull requests. Please follow the guidelines in the CONTRIBUTING.md file.
This project is licensed under the MIT License. See the LICENSE file for details.