Default Empty Flask Template

This is ready-to-go, bootstrapped Flask 1.0 project with some neat features like, Python3.6, Blueprint Structure, RESTfull api, Login & User Management, Basic Admin CMS with Basic Auth with a complete test suit!

Installation
Usage
Contributing
Credits
License
Wiki and FAQ's

Installation

First you need to create an Environment file. To do so, inside the projects root folder create a file named .env with the following key-value table:

APP_ENV=localhost
SECRET_KEY=KeepThisS3cr3t
SQLALCHEMY_DATABASE_URI=postgresql://localhost/database
BASIC_AUTH_USERNAME=me
BASIC_AUTH_PASSWORD=me

Note: To generate a fresh SECRET_KEY you can select any key from this website: http://randomkeygen.com/

This project uses Pipenv to install and manage all it's dependencies. So you just need to simply run:

$ pipenv install
(flask-template-project-Ad2ZDIA5) $ pipenv shell

And your virtual environment will be configured!

Usage

You have a list of available commands in the project manager. To run this project locally, you will use runserver. (To know more about all the commands available you can do $ python manage.py or consult the wiki page about Commands).

(flask-template-project-Ad2ZDIA5) $ python manage.py runserver
 * Serving Flask app "project" (lazy loading)
 * Environment: production
   WARNING: Do not use the development server in a production environment.
   Use a production WSGI server instead.
 * Debug mode: on
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 859-626-128

Flake8 configuration

Some custom properties were set when configuring Flake8 to validate if the codebase is PEP8 complain.

A new configuration file "flake8" was created on ~/.config/ folder.

You can find more following Flake8's documentation.

[flake8]
max-line-length = 120
ignore = E704  # Multiple statements on one line

Contributing

We deeply appreciate if you want to contribute to this project. To do so, please follow these guidelines.

Credits

This project could not have been done without the help of everyone involved. A HUGE thanks to @johnsardine 👍

Some resources that you can use to understand better this project:

License

Wiki and FAQ's

We try to keep our wiki up-to-date as best as we can, so if you have any questions, please use it! If you don't find anything regarding what you are looking for or if you have any suggestions, then create an issue and we will look at it as soon as possible. 👍

Fork, clone, share!

andreffs18/flask-template-project