https://github.com/app-generator/flask-argon-design-system-pro
Argon Design System PRO - Premium Flask Starter | AppSeed
https://github.com/app-generator/flask-argon-design-system-pro
appseed argon-design-system flask
Last synced: 12 months ago
JSON representation
Argon Design System PRO - Premium Flask Starter | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-argon-design-system-pro
- Owner: app-generator
- License: other
- Created: 2022-09-01T15:32:20.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-02T10:42:56.000Z (almost 4 years ago)
- Last Synced: 2025-07-20T05:57:21.594Z (12 months ago)
- Topics: appseed, argon-design-system, flask
- Homepage: https://appseed.us/product/argon-design-system-pro/flask/
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask Argon System PRO](https://appseed.us/product/argon-design-system-pro/flask/)
Seed project generated by AppSeed in **Flask** Framework on top of **Argon Design System PRO** with database, authentication, helpers and Docker support. Argon Design System PRO is built with over 1100 individual elements, 43 sections and 17 example pages giving you the freedom of choosing and combining.
- 👉 [Flask Argon System PRO](https://appseed.us/product/argon-design-system-pro/flask/) - product page
- 👉 [Flask Argon System PRO](https://flask-argon-design-system-pro.appseed-srv1.com/) - LIVE App
- 👉 [Complete documentation](https://docs.appseed.us/boilerplate-code/flask) - `Learn how to use and update the product`
> Features
- `Up-to-date dependencies`
- Database: `mysql`
- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
- Session-Based authentication (via **flask_login**), Forms validation
## ✨ Start the app in Docker
> **Step 1** - Download the [code](https://appseed.us/product/argon-design-system-pro/flask/) and unzip the sources (requires a `purchase`).
```bash
$ # Get the code
$ unzip flask-argon-design-system-pro.zip
$ cd flask-argon-design-system-pro
```
> **Step 2** - 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
> Download the [code](https://appseed.us/product/argon-design-system-pro/flask/) and unzip the sources (requires a `purchase`).
```bash
$ # Get the code
$ unzip flask-argon-design-system-pro.zip
$ cd flask-argon-design-system-pro
```
### 👉 Set Up for `Unix`, `MacOS`
> Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
```
> Start the app
```bash
$ flask run
```
At this point, the app runs at `http://127.0.0.1:5000/`.
### 👉 Set Up for `Windows`
> Install modules via `VENV` (windows)
```
$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt
```
> 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"
```
> Start the app
```bash
$ flask run
```
At this point, the app runs at `http://127.0.0.1:5000/`.
### 👉 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`
## Recompile SCSS
> Navigate to `apps/static/assets` and execute the gulp command default task in the directory.
Compilation tests were made with:
- **Node** `v16.15.0`
- **Gulp** `v4.0.2`, CLI version `4.0.2`
```bash
$ cd apps/static/assets
$ yarn # install modules
$ gulp # recompile SCSS
```
## ✨ 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 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.html # Used by common pages
| | |
| | |-- accounts/ # Authentication pages
| | | |-- login.html # Login page
| | | |-- register.html # Register page
| | |
| | |-- home/ # UI Kit Pages
| | |-- index.html # Index page
| | |-- page-404.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
|
|-- ************************************************************************
```
---
[Flask Argon System PRO](https://appseed.us/product/argon-design-system-pro/flask/) - Seed project generated by **[AppSeed Generator](https://appseed.us/generator/)**.