tnniras / flask-admin-boilerplate

Flask Admin Boilerplate with MongoDB

Flask Admin Boilerplate with SB Admin 2

This web application is built using the Python Flask Framework and SB Admin 2 Theme (Free version)

Features

• MongoDB database
• Session-Based authentication (Login and Register)
• SMTP Integration
• Gunicorn Deployment script
• MIT License
• SB Admin 2 Dashboard Theme
• Illustration from Undraw.co
• Support

Getting Started

The hosted version of this web application is found here

Prerequisites

• Python >= 3.5
• Pip, Virtualenv
• MongoDb Database
• SMTP Relay (Gmail, Sendgrid)

Installing

Follow the steps below to install the application

$ git clone 
$ cd flask-admin-boilerplate
$
$ virtualenv env
$ source env/bin/activate
$ 
$ # Install requirements
$ pip install -r requirements.txt

Make sure you configure the SMTP and Mongodb Database before running the application

Navigate to init.py under the configurations folder to configure your database and SMTP

Running the application

After installing all the requirements and ensuring that the configurations are done correctly, run the app.

$ # Run the application
$ python app.py

Deployment

This web application has the basic configuration for deployment with Gunicorn. Makes it easy for the application to be deployed on Heroku.

Support

For support or pull requests and github issues you can reach me via email [email protected] or [email protected]

Developer

Oyelekan Bukunmi Find out more about me here

License

This project is licensed under the MIT License

Donation

Acknowledgement

• Python Flask Framework - The web framework used
• SB Admin 2 Theme (Free version) - The UI theme used