https://github.com/ervinteoh/demo-flask-login
Flask Login demonstrates an authentication system on a website with Flask, TailwindCSS and PostgreSQL.
https://github.com/ervinteoh/demo-flask-login
docker flask flask-sqlalchemy javascript jinja postgresql python railway render tailwind-css webpack
Last synced: 3 months ago
JSON representation
Flask Login demonstrates an authentication system on a website with Flask, TailwindCSS and PostgreSQL.
- Host: GitHub
- URL: https://github.com/ervinteoh/demo-flask-login
- Owner: ervinteoh
- License: mit
- Created: 2022-12-16T14:48:09.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-25T02:38:48.000Z (over 3 years ago)
- Last Synced: 2025-10-11T11:34:15.733Z (9 months ago)
- Topics: docker, flask, flask-sqlalchemy, javascript, jinja, postgresql, python, railway, render, tailwind-css, webpack
- Language: Python
- Homepage: https://demo-flask-login.onrender.com
- Size: 5.98 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Flask Login
A demonstration of an authentication system on a website.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://demo-flask-login.onrender.com/)
### Built With
[![Python][Python-badge]][Python-url]
[![JavaScript][JavaScript-badge]][JavaScript-url]
[![Flask][Flask-badge]][Flask-url]
[![TailwindCSS][TailwindCSS-badge]][TailwindCSS-url]
[![Webpack][Webpack-badge]][Webpack-url]
[![PostgreSQL][PostgreSQL-badge]][PostgreSQL-url]
[![GitHub Actions][GitHubActions-badge]][GitHubActions-url]
[![Docker][Docker-badge]][Docker-url]
[![Render][Render-badge]][Render-url]
## Getting Started
### Prerequisites
* Node Package Management
```sh
npm install npm@latest -g
```
* Python
### Installation
1. Clone the repo
```sh
git clone https://github.com/ervinteoh/demo-flask-login.git
```
2. Install NPM packages
```sh
npm ci
```
3. Build Static Files
```sh
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
```sh
pip install -r requirements.txt
```
7. Database Migration
```sh
flask db upgrade
```
## Usage
Start the web application by simply running the command below.
```sh
flask run
```
To run the web application in debug mode run the following command instead.
```sh
export FLASK_DEBUG=1
flask run
```
Use the following command to find out more about the flask command line interface.
```sh
flask --help
```
## Roadmap
- [x] Milestone 1
- [ ] Milestone 2
- [ ] Milestone 3
See the [open issues](https://github.com/ervinteoh/demo-flask-login/issues) for a full list of proposed features (and known issues).
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Jie Sheng Teoh (Ervin) - teohjies@gmail.com
Project Link: [https://github.com/ervinteoh/demo-flask-login](https://github.com/ervinteoh/demo-flask-login)
## Acknowledgments
* [README Template](https://github.com/othneildrew/Best-README-Template)
* [Freepik Illustrations](https://www.freepik.com/search?author=55705010&authorSlug=bs_k1d&format=author)
[contributors-shield]: https://img.shields.io/github/contributors/ervinteoh/demo-flask-login.svg?style=for-the-badge
[contributors-url]: https://github.com/ervinteoh/demo-flask-login/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/ervinteoh/demo-flask-login.svg?style=for-the-badge
[forks-url]: https://github.com/ervinteoh/demo-flask-login/network/members
[stars-shield]: https://img.shields.io/github/stars/ervinteoh/demo-flask-login.svg?style=for-the-badge
[stars-url]: https://github.com/ervinteoh/demo-flask-login/stargazers
[issues-shield]: https://img.shields.io/github/issues/ervinteoh/demo-flask-login.svg?style=for-the-badge
[issues-url]: https://github.com/ervinteoh/demo-flask-login/issues
[license-shield]: https://img.shields.io/github/license/ervinteoh/demo-flask-login.svg?style=for-the-badge
[license-url]: https://github.com/ervinteoh/demo-flask-login/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/ervinteoh
[product-screenshot]: images/screenshot.png
[Python-badge]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54
[Python-url]: https://www.python.org/
[JavaScript-badge]: https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E
[JavaScript-url]: https://www.javascript.com/
[Flask-badge]: https://img.shields.io/badge/flask-%23000.svg?style=for-the-badge&logo=flask&logoColor=white
[Flask-url]: https://flask.palletsprojects.com/
[TailwindCSS-badge]: https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white
[TailwindCSS-url]: https://tailwindcss.com/
[Webpack-badge]: https://img.shields.io/badge/webpack-%238DD6F9.svg?style=for-the-badge&logo=webpack&logoColor=black
[Webpack-url]: https://webpack.js.org/
[PostgreSQL-badge]: https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white
[PostgreSQL-url]: https://www.postgresql.org/
[GitHubActions-badge]: https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white
[GitHubActions-url]: https://github.com/features/actions
[Docker-badge]: https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white
[Docker-url]: https://www.docker.com/
[Render-badge]: https://img.shields.io/badge/Render-%46E3B7.svg?style=for-the-badge&logo=render&logoColor=white
[Render-url]: https://render.com/