Flask Login

A demonstration of an authentication system on a website.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

• Node Package Management

  npm install npm@latest -g

• Python

Installation

1. Clone the repo

   git clone https://github.com/ervinteoh/demo-flask-login.git

2. Install NPM packages

   npm ci

3. Build Static Files

   npm run build

4. Make a copy of the file .env.example and rename it to .env
5. Fill in the missing environmental variables in .env file
6. Install package requirements

   pip install -r requirements.txt

7. Database Migration

   flask db upgrade

(back to top)

Usage

Start the web application by simply running the command below.

flask run

To run the web application in debug mode run the following command instead.

export FLASK_DEBUG=1
flask run

Use the following command to find out more about the flask command line interface.

flask --help

(back to top)

Roadmap

• Milestone 1
• Milestone 2
• Milestone 3

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Jie Sheng Teoh (Ervin) - teohjies@gmail.com

Project Link: https://github.com/ervinteoh/demo-flask-login

(back to top)

Acknowledgments

• README Template
• Freepik Illustrations

(back to top)