Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cypher-o/expense_tracker
An expense tracker API built using FastAPI
https://github.com/cypher-o/expense_tracker
expense-tracker fastapi python
Last synced: 14 days ago
JSON representation
An expense tracker API built using FastAPI
- Host: GitHub
- URL: https://github.com/cypher-o/expense_tracker
- Owner: Cypher-O
- License: mit
- Created: 2024-10-27T19:35:17.000Z (18 days ago)
- Default Branch: main
- Last Pushed: 2024-10-27T21:01:04.000Z (18 days ago)
- Last Synced: 2024-10-28T00:38:15.740Z (18 days ago)
- Topics: expense-tracker, fastapi, python
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Expense Tracker API
A simple and efficient API for tracking expenses, allowing users to create, retrieve, update, and delete expense entries.
## Features
- Create new expenses
- Retrieve a list of expenses
- Get details of a specific expense
- Update existing expenses
- Delete expenses
## Getting Started
### Prerequisites
- Python 3.9+
- pip (Python package installer)
### Installation
1. Clone the repository:
```sh
git clone https://github.com/cypher-o/expense_tracker.git
```
```sh
cd expense_tracker
```
2. Install the required packages:
```sh
pip install -r requirements.txt
```
### Running the API
To run the API locally, use the following command:
```sh
uvicorn app.main:app --reload
```
Once the server is running, you can access the API at `http://127.0.0.1:8000`
### API Documentation
The API documentation is automatically generated by FastAPI and can be accessed at:
- Swagger UI: `http://127.0.0.1:8000/docs`
- ReDoc: `http://127.0.0.1:8000/redoc`
### License
This project is licensed under the MIT License - see the LICENSE file for details.
### Contributing
Contributions are welcome! Please open an issue or submit a pull request.
### Acknowledgements
- FastAPI - The web framework used.
- SQLAlchemy - Database toolkit for Python.