Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helloflask/flemi-api
Flemi API
https://github.com/helloflask/flemi-api
apiflask flask
Last synced: 9 days ago
JSON representation
Flemi API
- Host: GitHub
- URL: https://github.com/helloflask/flemi-api
- Owner: helloflask
- Created: 2022-04-18T05:17:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-04T16:56:33.000Z (about 1 month ago)
- Last Synced: 2024-11-04T17:44:56.370Z (about 1 month ago)
- Topics: apiflask, flask
- Language: Python
- Homepage:
- Size: 136 KB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - helloflask/flemi-api - Flemi API (Python)
README
# Flemi API
> **Tips:** This repository is still under construction.
This project is the new version of z-t-y/Flog.
This written is written to be the back-end of this website project, there's also a front-end
project of Flemi (using React.js).
## How to install
Flemi API uses [PDM](https://github.com/pdm-project/pdm) to manage its dependencies,
so you should install PDM first:
```powershell
pip install pipx
pipx install pdm
```
then install with PDM:
```powershell
pdm install
```
To initialize Flemi API, you must make the database and administrator ready with command:
```powershell
flask deploy
flask create-admin
```
If you want to generate fake data for testing, you should use command `flask forge` after
running the command above.
Then you can run our Flemi API. In most cases just use `flask run`, but if you use servers
like PythonAnywhere, Heroku, etc. Read its docs and go on.
## Credits
Flemi project is created by [@z-t-y](https://github.com/z-t-y). Now maintained by [helloflask/floggers](https://github.com/orgs/helloflask/teams/floggers). See contributors for more information.