Skip to content

Raoul1996/flask-boilerplate

 
 

Repository files navigation

Flask Robot Backend

use flask to implement a simple API Server

API Docs

PostMan

Dependencies

See requirements.txt

Features

  1. Auth
  2. register mail, verify email address
  3. forget password mail(not support modified password)
  4. Data CURD
  5. Params validation
  6. Custom Http Exception
  7. Pagination
  8. uwsgi + nginx

More features will coming.....

Development

use python3.5

chmod +x setup.sh
./setup.sh

Maybe your should change to postgres user to create db user:

sudo -s -u postgres
psql -c "create user testusr with password 'password';"
psql -c "ALTER USER testusr WITH SUPERUSER;" 

Don't use the default password

Set Env

Run server in debug mode

export FLASK_DEBUG=True

want to send your email?

export qqmailaddress="your_mail_address@foxmail.com"
export qqmailpass="your_mail_auth_code" # not the qq password.

Run Server

python manage.py recreate_db
python manage.py runserver

Verify server status

curl http://0.0.0.0:5000

Any Questions?

welcome to create a issue.

Other Detail? Please See the Old README

OLD_README

Thanks for tko22

About

Simple flask boilerplate with Postgres, Docker, and Heroku/Zeit now

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 96.2%
  • HTML 2.7%
  • Shell 1.1%