Popularity
1.8
Growing
Activity
6.2
Growing
77
6
19

Description

Open-Source Flask app enhanced with SQLite database, authentication, SQLAlchemy ORM and a beautiful UI - Paper Kit Design by Creative-Tim.

Programming language: CSS
Tags: RESTful API     Flask     Python     AppSeed     Boilerplate    

Flask Paper Kit alternatives and similar packages

Based on the "Flask" category

Do you think we are missing an alternative of Flask Paper Kit or a related project?

Add another 'Flask' Package

README

Flask Paper Kit

Open-Source Web App coded in Flask Web Framework on top of Paper Kit design, crafted by Creative-Tim agency. Features:

  • SQLite
  • SQLAlchemy ORM
  • Session-Based authentication (via flask_login)
  • Forms validation
  • License MIT

Flask Paper Kit - Open-Source Web App coded in Flask.

Setup the environment

In order to use the boilerplate, we need Python3 and virtualenv python library.

Note: Python2 is not supported, the EOL of this version announced here. In order to use our kits, please migrate to Pyhton3.

$ # Test the Python install
$ python --version
$ Python 3.7.2
$
$ # install Virtualenv using PIP
$ pip3 install virtualenv

Build from sources

$ # 1. Get the code
$ git clone https://github.com/app-generator/flask-paper-kit.git
$ cd flask-paper-kit
$
$ # Install modules using a virtualenv (Unix based systems)
$ virtualenv --no-site-packages env
$ source env/bin/activate
$
$ # Install modules using a virtualenv (Windows based systems)
$ # virtualenv --no-site-packages env
$ # .\env\Scripts\activate.bat
$ 
$ # 2. Install requirements
$ pip3 install -r requirements.txt
$
$ # 3. Set the FLASK_APP environment variable
$ (Unix/Mac) export FLASK_APP=run.py
$ (Windows) set FLASK_APP=run.py
$ (Powershell) $env:FLASK_APP = ".\run.py"
$
$ # Create SQLite database using the Flask console
$ flask shell
>> from app import db
>> db.create_all()
>> quit()
$ # SQLite database.db should be created in the app folder:
$ # app\database.db
$
$ # 4. Run the application
$ flask run --host=0.0.0.0
$
$ # 5. Go to http://127.0.0.1:5000/, create an account and log in

Project Structure

The boilerplate code is built with a modular structure that follows the recommended pattern used by many open-source projects. The most important files / directories are listed bellow:

< ROOT > - Flask Paper Kit        # application root folder
    |
    |--- app/__init__.py          # application constructor  
    |--- app/views.py             # implement app routing
    |--- app/models.py            # define app models
    |--- app/forms.py             # forms used for login and registration
    |
    |--- requirements.txt         # App Requirements
    |
    |--- run.py                   # bootstrap the app
    |
    |-----------------------------

Support


Flask Paper Kit - provided by AppSeed


*Note that all licence references and agreements mentioned in the Flask Paper Kit README section above are relevant to that project's source code only.