Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaronw-be/flask-api-project
A project kick starter for python flask framework
https://github.com/aaronw-be/flask-api-project
Last synced: 11 days ago
JSON representation
A project kick starter for python flask framework
- Host: GitHub
- URL: https://github.com/aaronw-be/flask-api-project
- Owner: AaronW-BE
- Created: 2021-03-11T15:52:43.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-23T03:03:39.000Z (almost 4 years ago)
- Last Synced: 2024-11-12T15:33:52.893Z (2 months ago)
- Language: Python
- Size: 19.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FAPS -- Flask-Api-Project-Skeleton
A project kick starter for python flask framework
### Frameworks
* Flask
* Flask-RESTful
* Flask-SQLAlchemy
* Flask-JWT-Extended
* flask_marshmallow
### Installing
* set virtual env for python: `py -3 -m venv venv` (python 3 on windows)
* activate virtual environment: `venv\Scripts\activate`
* install dependencies: `pip install -r requirement.txt`
### Running at PowerShell (dev mode)
```shell
$env:FLASK_APP="server"
$env:FLASK_ENV="development"
flask run # start application
```
### Model
Run `py create_tables.py` to generate basic db table
### Tree structure
```
┌─ server
│ ├── resources
│ │ ├── book.py
│ │ └── __init__.py
│ ├── models.py
│ ├── jwt
│ ├── bp
│ │ ├── auth.py
│ │ └── __init__.py
│ └── __init__.py
├── setup.py
├── requirements.txt
├── create_tables.py
├── README.md
└── MANIFEST.in
```