Update README

This commit is contained in:
Andros Fenollosa 2017-05-18 18:53:23 +02:00
parent e09c4abf8c
commit d58c4efcc1
9 changed files with 60 additions and 0 deletions

55
README.md Normal file
View File

@ -0,0 +1,55 @@
# Flask Example: Login, Signup and Forgot password
[DEMO](http://flask-login-example.programadorwebvalencia.com)
![login](https://github.com/tanrax/flask-login-example/raw/master/screenshots/login.jpg)
## Description
* Login system.
* Signup.
* Forgot password.
* Validations.
* Private page only for registered users.
* System emails.
## Use
* Flask (Obvious!)
* Flask-SQLAlchemy (ORM for database)
* Flask-WTF (Generation of forms and validations)
* Flask-Migrate(Migratios)
* Flask-Mail(Send emails)
## Install
```bash
cp envExample .env
```
Configure variables. Next.
```bash
source .env
pip install -r requirements.txt
```
Create database.
```bash
python3 models.py db upgrade
```
## Run
```bash
python3 app.py
```
## Screenshots
![signup](https://github.com/tanrax/flask-login-example/raw/master/screenshots/signup.jpg)
![message](https://github.com/tanrax/flask-login-example/raw/master/screenshots/message.jpg)
![forgot](https://github.com/tanrax/flask-login-example/raw/master/screenshots/forgot.jpg)
![email](https://github.com/tanrax/flask-login-example/raw/master/screenshots/email.jpg)
![dashboard](https://github.com/tanrax/flask-login-example/raw/master/screenshots/dashboard.jpg)

Binary file not shown.

5
requirements.txt Normal file
View File

@ -0,0 +1,5 @@
Flask==0.12.1
Flask-Mail==0.9.1
Flask-Migrate==2.0.3
Flask-SQLAlchemy==2.2
Flask-WTF==0.14.2

BIN
screenshots/dashboard.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

BIN
screenshots/email.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

BIN
screenshots/forgot.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
screenshots/login.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

BIN
screenshots/message.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

BIN
screenshots/signup.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB