https://github.com/app-generator/flask-corona-dark
Flask Dashboard - Corona Dark Design | AppSeed
https://github.com/app-generator/flask-corona-dark
flask-apps flask-dashboard flask-template jinja
Last synced: 4 months ago
JSON representation
Flask Dashboard - Corona Dark Design | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-corona-dark
- Owner: app-generator
- License: other
- Created: 2020-05-25T07:30:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T15:02:03.000Z (about 2 years ago)
- Last Synced: 2025-08-12T19:48:52.283Z (4 months ago)
- Topics: flask-apps, flask-dashboard, flask-template, jinja
- Language: CSS
- Homepage: https://appseed.us/product/corona-dark/flask/
- Size: 27.4 MB
- Stars: 49
- Watchers: 3
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask Corona Dark](https://appseed.us/product/corona-dark/flask/)
Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** generated by `AppSeed` on top of a modern design. **Corona Dark** (free version) has beautiful typography, crisp design, and neatly designed dashboards. It combines colors that are easy on the eye, spacious cards, beautiful typography, and graphics.
- 👉 [Flask Corona Dark](https://appseed.us/product/corona-dark/flask/) - `product page`
- 👉 [Flask Corona Dark](https://flask-corona-dark.appseed-srv1.com/) - `LIVE Demo`
> 🚀 Built with [App Generator](https://appseed.us/generator/)
- ✅ `Up-to-date dependencies`
- ✅ Database: `sqlite`
- ✅ `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
- ✅ Session-Based authentication (via **flask_login**), Forms validation
- ✅ `Docker`
## ✨ Quick Start in `Docker`
> 👉 Get the code
```bash
$ git clone https://github.com/app-generator/flask-corona-dark.git
$ cd flask-corona-dark
```
> 👉 Start the app in Docker
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## ✨ How to use it
```bash
$ # Get the code
$ git clone https://github.com/app-generator/flask-corona-dark.git
$ cd flask-corona-dark
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
$
$ # Install modules - SQLite Database
$ pip3 install -r requirements.txt
$
$ # OR with PostgreSQL connector
$ # pip install -r requirements-pgsql.txt
$
$ # Set the FLASK_APP environment variable
$ (Unix/Mac) export FLASK_APP=run.py
$ (Windows) set FLASK_APP=run.py
$ (Powershell) $env:FLASK_APP = ".\run.py"
$
$ # Set up the DEBUG environment
$ # (Unix/Mac) export FLASK_ENV=development
$ # (Windows) set FLASK_ENV=development
$ # (Powershell) $env:FLASK_ENV = "development"
$
$ # Start the application (development mode)
$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)
$ # --port=5000 - specify the app port (default 5000)
$ flask run --host=0.0.0.0 --port=5000
$
$ # Access the dashboard in browser: http://127.0.0.1:5000/
```
> Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages.
## ✨ Code-base structure
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production), and an intuitive structure presented below:
```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 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 # Development modules - SQLite storage
|-- requirements-mysql.txt # Production modules - Mysql DMBS
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
|
|-- Dockerfile # Deployment
|-- docker-compose.yml # Deployment
|-- gunicorn-cfg.py # Deployment
|-- nginx # Deployment
| |-- appseed-app.conf # Deployment
|
|-- .env # Inject Configuration via Environment
|-- run.py # Start the app - WSGI gateway
|
|-- ************************************************************************
```
## ✨ Recompile CSS
To recompile SCSS files, follow this setup:
**Step #1** - Install tools
- [NodeJS](https://nodejs.org/en/) 12.x or higher
- [Gulp](https://gulpjs.com/) - globally
- `npm install -g gulp-cli`
- [Yarn](https://yarnpkg.com/) (optional)
**Step #2** - Change the working directory to `assets` folder
```bash
$ cd apps/static/assets
```
**Step #3** - Install modules (this will create a classic `node_modules` directory)
```bash
$ npm install
// OR
$ yarn
```
**Step #4** - Edit & Recompile SCSS files
```bash
$ gulp scss
```
The generated file is saved in `static/assets/css` directory.
---
[Flask Corona Dark](https://appseed.us/product/corona-dark/flask/) - Provided by **[App Generator](https://appseed.us/app-generator)**.