Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
app-generator authored Jan 14, 2022
1 parent 6fffe3e commit f284a7a
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,24 @@

> Features
- Up-to-date [dependencies](./requirements.txt): **Flask 2.0.1**
- `Up-to-date dependencies`: **Flask 2.0.1**
- [SCSS compilation](#recompile-css) via **Gulp**
- DBMS: SQLite, PostgreSQL (production)
- DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
- Modular design with **Blueprints**, simple codebase
- `DBMS`: SQLite, PostgreSQL (production)
- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
- Session-Based authentication (via **flask_login**), Forms validation
- Deployment scripts: Docker, Gunicorn / Nginx, Heroku
- Support via **Github** and [Discord](https://discord.gg/fZC6hup).
- `Deployment`: **Docker**, Gunicorn / Nginx, HEROKU
- Support via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup).

<br />

> Links
- [Flask Bootstrap 5 Volt](https://appseed.us/admin-dashboards/flask-dashboard-volt) - product page
- [Flask Bootstrap 5 Volt](https://flask-volt-dashboard.appseed-srv1.com/) - LIVE deployment
- 👉 [Flask Bootstrap 5 Volt](https://appseed.us/admin-dashboards/flask-dashboard-volt) - product page
- 👉 [Flask Bootstrap 5 Volt](https://flask-volt-dashboard.appseed-srv1.com/) - LIVE deployment

<br />

## Quick Start in [Docker](https://www.docker.com/)
## Quick Start in `Docker`

> Get the code
Expand All @@ -47,7 +46,7 @@ Visit `http://localhost:85` in your browser. The app should be up & running.

<br />

## How to use it
## How to use it

```bash
$ # Get the code
Expand Down Expand Up @@ -90,7 +89,7 @@ $ # Access the dashboard in browser: http://127.0.0.1:5000/
<br />

## Code-base structure
## Code-base structure

The project is coded using blueprints, app factory pattern, dual configuration profile (development and production), and an intuitive structure presented below:

Expand Down Expand Up @@ -151,7 +150,7 @@ The project is coded using blueprints, app factory pattern, dual configuration p

<br />

## Recompile CSS
## Recompile CSS

To recompile SCSS files, follow this setup:

Expand Down Expand Up @@ -194,7 +193,7 @@ The generated file is saved in `static/assets/css` directory.

<br />

## Deployment
## Deployment

The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Heroku](https://www.heroku.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).

Expand Down Expand Up @@ -275,7 +274,7 @@ Visit `http://localhost:8001` in your browser. The app should be up & running.

<br />

## Credits & Links
## Credits & Links

- [Flask Framework](https://www.palletsprojects.com/p/flask/) - The offcial website
- [Boilerplate Code](https://appseed.us/boilerplate-code) - Index provided by **AppSeed**
Expand Down

0 comments on commit f284a7a

Please sign in to comment.