Simply clone this repository and start a new Flask app base on it.
Its already has some features:
- basic user api (register/login/send_verification_code), and login_required decorator;
- swagger api docs;
- some tests and some useful pytest fixtures;
- ...
Clone this repository:
> git clone [email protected]:kant-li/NewFlaskApp.git
Configs will be parsed from file .env, please create it and write in basic configs.
Or the app will use the default value in config.py.
An example of .env file:
# mysql
MYSQL_ADDRESS=127.0.0.1
MYSQL_PORT=3306
MYSQL_DATABASE=flask_app
MYSQL_USER=flask_app
MYSQL_PASSWORD=password
# redis
...
MySQL and Redis will be needed.
If there is no database running, run one by docker:
> docker-compose up
Init MySQL by running the sql scripts:
> mysql -u your_user_name -p
mysql> source sql/add_user_pv.sql;
mysql> source sql/add_tables.sql;
Init the python virtual environment and install packages:
> virtualenv venv
> source venv/bin/activate
> pip install -r requirements.txt
Start server:
> python manage.py runserver
API: http://localhost:5000/apidocs/
Do remember to commit to a new branch for new features.
Run pytest:
> python -m pytest