Update README.md

Author: app-generator

README.md

@@ -1 +1,212 @@
-# flask-soft-dashboard-tailwind
+# Soft Dashboard Tailwind Flask
+
+Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern design. Designed for those who like bold elements and beautiful websites, **[Soft UI Dashboard](https://appseed.us/generator/soft-ui-dashboard/)** is ready to help you create stunning websites and webapps. **Soft UI Dashboard** is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
+
+- 👉 [Soft Dashboard Tailwind Flask](#) - `Product page` (soon)
+- 👉 [Soft Dashboard Tailwind Flask](#) - `LIVE Demo` (soon)
+
+<br />
+
+> Features
+
+- CSS Framework: `Tailwind`
+- `Up-to-date dependencies`
+- Database: `sqlite`
+- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
+- Session-Based authentication (via **flask_login**), Forms validation
+
+<br />
+
+![Soft UI Dashboard - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168843143-f2a2ffac-4ab6-44d2-bc1f-a9a8682a749b.png)
+
+<br />
+
+
+## ✨ Start the app in Docker
+
+> **Step 1** - Download the code from the GH repository (using `GIT`) 
+
+```bash
+$ # Get the code
+$ git clone https://github.com/app-generator/flask-soft-dashboard-tailwind.git
+$ cd flask-soft-dashboard-tailwind
+```
+
+<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`
+
+```bash
+$ docker-compose up --build 
+```
+
+Visit `http://localhost:85` in your browser. The app should be up & running.
+
+<br />
+
+## ✨ How to use it
+
+> Download the code 
+
+```bash
+$ # Get the code
+$ git clone https://github.com/app-generator/flask-soft-dashboard-tailwind.git
+$ cd flask-soft-dashboard-tailwind
+```
+
+<br />
+
+### 👉 Set Up for `Unix`, `MacOS` 
+
+> Install modules via `VENV`  
+
+```bash
+$ virtualenv env
+$ source env/bin/activate
+$ pip3 install -r requirements.txt
+```
+
+<br />
+
+> Set Up Flask Environment
+
+```bash
+$ export FLASK_APP=run.py
+$ export FLASK_ENV=development
+```
+
+<br />
+
+> Start the app
+
+```bash
+$ flask run
+```
+
+At this point, the app runs at `http://127.0.0.1:5000/`. 
+
+<br />
+
+### 👉 Set Up for `Windows` 
+
+> Install modules via `VENV` (windows) 
+
+```
+$ virtualenv env
+$ .\env\Scripts\activate
+$ pip3 install -r requirements.txt
+```
+
+<br />
+
+> Set Up Flask Environment
+
+```bash
+$ # CMD 
+$ set FLASK_APP=run.py
+$ set FLASK_ENV=development
+$
+$ # Powershell
+$ $env:FLASK_APP = ".\run.py"
+$ $env:FLASK_ENV = "development"
+```
+
+<br />
+
+> Start the app
+
+```bash
+$ flask run
+```
+
+At this point, the app runs at `http://127.0.0.1:5000/`. 
+
+<br />
+
+### 👉 Create Users
+
+By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: 
+
+- Start the app via `flask run`
+- Access the `registration` page and create a new user:
+  - `http://127.0.0.1:5000/register`
+- Access the `sign in` page and authenticate
+  - `http://127.0.0.1:5000/login`
+
+<br />
+
+## ✨ Code-base structure
+
+The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
+
+```bash
+< PROJECT ROOT >
+   |
+   |-- apps/
+   |    |
+   |    |-- home/                           # A simple app that serve HTML files
+   |    |    |-- routes.py                  # Define app routes
+   |    |
+   |    |-- authentication/                 # Handles auth routes (login and register)
+   |    |    |-- routes.py                  # Define authentication routes  
+   |    |    |-- models.py                  # Defines models  
+   |    |    |-- forms.py                   # Define auth forms (login and register) 
+   |    |
+   |    |-- static/
+   |    |    |-- <css, JS, images>          # CSS files, Javascripts files
+   |    |
+   |    |-- templates/                      # Templates used to render pages
+   |    |    |-- includes/                  # HTML chunks and components
+   |    |    |    |-- navigation.html       # Top menu component
+   |    |    |    |-- sidebar.html          # Sidebar component
+   |    |    |    |-- footer.html           # App Footer
+   |    |    |    |-- scripts.html          # Scripts common to all pages
+   |    |    |
+   |    |    |-- layouts/                   # Master pages
+   |    |    |    |-- base-fullscreen.html  # Used by Authentication pages
+   |    |    |    |-- base.html             # Used by common pages
+   |    |    |
+   |    |    |-- accounts/                  # Authentication pages
+   |    |    |    |-- login.html            # Login page
+   |    |    |    |-- register.html         # Register page
+   |    |    |
+   |    |    |-- home/                      # UI Kit Pages
+   |    |         |-- index.html            # Index page
+   |    |         |-- 404-page.html         # 404 page
+   |    |         |-- *.html                # All other pages
+   |    |    
+   |  config.py                             # Set up the app
+   |    __init__.py                         # Initialize the app
+   |
+   |-- requirements.txt                     # App Dependencies
+   |
+   |-- .env                                 # Inject Configuration via Environment
+   |-- run.py                               # Start the app - WSGI gateway
+   |
+   |-- ************************************************************************
+```
+
+<br />
+
+## ✨ Customize CSS
+
+- Edit the `apps/static/assets/scss/styles.css`
+- Regenerate the CSS
+
+```bash
+$ npm i
+$ npm run build
+```
+
+<br />
+
+---
+[Soft UI Dashboard](https://appseed.us/generator/soft-ui-dashboard/) Flask - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.