Release v1.0.5 - OAuth, Extended Profiles

Author: app-generator

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## [1.0.5] 2022-09-13
+### Improvements
+
+- Improved Authentication
+  - Visual password strength indicator (registration)  
+  - **Social Login**: `Github` & `Twitter`
+- New Feature: `User Profiles`
+  - `Extended User` profile
+  - `Self-Deletion` option
+- Improved `Docker` Scripts  
+
 ## [1.0.4] 2022-08-10
 ### Improvements (Minor)
 

README.md

@@ -3,31 +3,21 @@
 **Flask Web App** generated by `AppSeed` op top of a modern design. Designed for those who like bold elements and beautiful websites, **Soft UI Design PRO** is ready to help you create stunning websites and webapps. 
 
 - 👉 [Soft UI Design PRO Flask](https://appseed.us/product/soft-ui-design-pro/flask/) - Product page
-- 👉 [Soft UI Design PRO Flask](https://flask-soft-ui-design-pro.appseed-srv1.com/) - LIVE Demo
+- 👉 [Soft UI Design PRO Flask](https://flask-soft-design-enh.appseed-srv1.com) - LIVE Demo
 - 👉 [Complete documentation](https://docs.appseed.us/products/flask-apps/soft-ui-design-pro) - `Learn how to use and update the product`
-  - ✅ [Set up the environment](https://docs.appseed.us/products/flask-apps/soft-ui-design-pro#environment)
-  - ✅ [Start the app in Docker](https://docs.appseed.us/products/flask-apps/soft-ui-design-pro#start-the-app-in-docker)
-  - ✅ [Manual Build](https://docs.appseed.us/products/flask-apps/soft-ui-design-pro#manual-build)
-  - ✅ [UI Assets and Templates](https://docs.appseed.us/products/flask-apps/soft-ui-design-pro#ui-assets-and-templates)
-  - ✅ [Set up the MySql Database](https://docs.appseed.us/products/flask-apps/soft-ui-design-pro#set-up-the-mysql-database)
-  - ✅ [Static Assets for production](https://docs.appseed.us/products/flask-apps/soft-ui-design-pro#static-assets-for-production)  
 
 <br />
 
-> Built with [Soft UI Design PRO Generator](https://appseed.us/generator/soft-ui-design-pro/)
-
-- Timestamp: `2022-06-14 10:26`
-- Build ID: `695828fa-ebdd-4761-b458-b967789be914`
-- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
-
-<br />
-
 > Features
 
 - `Up-to-date dependencies`
-- Database: `mysql`
+- Database: `MySql`, `SQLite`
 - `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
-- Session-Based authentication (via **flask_login**), Forms validation
+- **Authentication**
+  - `Session-Based authentication`
+  - `Social Login` (optional) for **Github** & **Twitter**
+- **User profiles**
+  - `Extended profile`, `Self-Deletion`
 
 <br />
 
@@ -41,21 +31,13 @@
 
 ```bash
 $ # Get the code
-$ unzip flask-soft-ui-design-pro.zip
-$ cd flask-soft-ui-design-pro
+$ unzip flask-soft-ui-design-enh.zip
+$ cd flask-soft-ui-design-enh
 ```
 
 <br />
 
-> **Step 2** - Edit `.env` and set `DEBUG=True`. This will activate the `SQLite` persistance. 
-
-```txt
-DEBUG=True
-```
-
-<br />
-
-> **Step 3** - Start the APP in `Docker`
+> **Step 2** - Start the APP in `Docker`
 
 ```bash
 $ docker-compose up --build 
@@ -65,6 +47,29 @@ Visit `http://localhost:5085` in your browser. The app should be up & running.
 
 <br />
 
+## ✨ Create a new `.env` file using sample `env.sample`
+
+The meaning of each variable can be found below: 
+
+- `DEBUG`: if `True` the app runs in develoment mode
+  - For production value `False` should be used
+- `ASSETS_ROOT`: used in assets management
+  - default value: `/static/assets`
+- `MYSQL` credentials 
+  - `DB_ENGINE`, default value = `mysql`
+  - `DB_NAME`, default value = `appseed_db`
+  - `DB_HOST`, default value = `localhost`
+  - `DB_PORT`, default value = `3306`
+  - `DB_USERNAME`, default value = `appseed_db_usr`
+  - `DB_PASS`, default value = `pass`
+- `OAuth` via Github
+  - `GITHUB_ID`=<GITHUB_ID_HERE>
+  - `GITHUB_SECRET`=<GITHUB_SECRET_HERE> 
+- `OAuth` via Twitter
+  - `TWITTER_ID`=<TWITTER_ID_HERE>
+  - `TWITTER_SECRET`=<TWITTER_SECRET_HERE> 
+
+<br /> 
 
 ## ✨ Set up the MySql Database
 
@@ -105,15 +110,14 @@ DB_PORT=3306                # MySql port, default = 3306
 
 <br />
 
-
 ## ✨ How to use it
 
 > Download the [code](https://appseed.us/product/soft-ui-design-pro/flask/) and unzip the sources (requires a `purchase`). 
 
 ```bash
 $ # Get the code
-$ unzip flask-soft-ui-design-pro.zip
-$ cd flask-soft-ui-design-pro
+$ unzip flask-soft-ui-design-enh.zip
+$ cd flask-soft-ui-design-enh
 ```
 
 <br />
@@ -250,7 +254,5 @@ The project is coded using blueprints, app factory pattern, dual configuration p
 
 <br />
 
-
-
 ---
 Soft UI Design PRO Flask - Seed Project generated by **[AppSeed Generator](https://appseed.us/generator/)**.