https://github.com/p1etrodev/local-finances-api
https://github.com/p1etrodev/local-finances-api
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/p1etrodev/local-finances-api
- Owner: P1etrodev
- License: apache-2.0
- Created: 2025-05-04T05:49:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-04T06:03:05.000Z (about 1 year ago)
- Last Synced: 2025-05-07T04:59:28.441Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Finances API
A locally hosted finances-oriented API developed to be consumed from whatever app you'd like to build.
You can use `C++ with Qt`, `Python with TKinter`, `NodeJS with Angular` or any other UI developing library/framework you preffer.
---
## Deploy
To host and deploy the API, run `python manage.py runserver` or execute `server.exe` at the `/dist/server` folder.
## Endpoints
Once hosted, you can access the endpoints from the base [URL](http://localhost:8000/).
Take a look to the [auto-generated docs](http://localhost:8000/docs) to get some more info about the available endpoints.
## Build
This project was originally meant to be ran and accessed locally, hosted from an executable file.
You can build the executable by running `pyinstaller manage.py --name server --noconfirm` or executing the [build.bat](/build.bat) script from the terminal. After the building process, you'll end up with 2 folders, the final product is located at `/dist`.
## Storage
All the data is located at the [db.sqlite3](/db.sqlite3) file, in case you need to rebuild the server just save a copy of that file.
> ⚠️ If you modify the model structures (any of the `models.py` files), your saved data could be lost **completely**.