Install dependencies in once the virtualenv is activated
1
$ pip install -r requirements.txt
Copied!
Step #3 - Prepare the environment
1
$ export FLASK_APP=run.py
2
$ export FLASK_ENV=development
Copied!
Or for Windows-based systems
1
$ (Windows CMD) set FLASK_APP=run.py
2
$ (Windows CMD) set FLASK_ENV=development
3
$
4
$ (Powershell) $env:FLASK_APP = ".\run.py"
5
$ (Powershell) $env:FLASK_ENV = "development"
Copied!
Step #4 - Initialize the database, check run.py for shell context
1
$ flask shell
2
>>> from api import db
3
>>> db.create_all()
Copied!
Step #5 - Start the API server
1
$ python run.py
2
// OR
3
$ flask run
Copied!
Visit http://localhost:5000 in your browser. The API server will be running.
Project Structure
The codebase has a simple, intuitive structure where run.py is responsible to bundle and start the API Server using the setup coded by the api folder:
1
api-server-flask/
2
├── api
3
│ ├── config.py
4
│ ├── __init__.py
5
│ ├── models.py
6
│ └── routes.py
7
├── Dockerfile
8
├── README.md
9
├── requirements.txt
10
├── run.py
11
└── tests.py
Copied!
Compatible Fullstack Products
The product can be used as a standalone server but also as an authentication server for React, Vue products. Such a product already configured with Django API Server is React Datta Able, an open-source React Dashboard.