Skip to content

Commit

Permalink
Release v1.0.5 - Bump Codebase Version
Browse files Browse the repository at this point in the history
  • Loading branch information
App Generator committed Jan 16, 2022
1 parent c88bcd9 commit 538e204
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 35 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,17 @@
# Change Log

## [1.0.5] 2022-01-16
### Improvements

- Bump Flask Codebase to [v2stable.0.1](https://github.com/app-generator/boilerplate-code-flask-dashboard/releases)
- Dependencies update (all packages)
- Flask==2.0.2 (latest stable version)
- flask_wtf==1.0.0
- jinja2==3.0.3
- flask-restx==0.5.1
- Forms Update:
- Replace `TextField` (deprecated) with `StringField`

## [1.0.4] 2021-11-08
### Improvements

Expand Down
45 changes: 21 additions & 24 deletions README.md
Expand Up @@ -6,40 +6,37 @@ Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask)** gen

> Features
- Up-to-date [dependencies](./requirements.txt): **Flask 2.0.1**
- `Up-to-date dependencies`
- [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
- [Atlantis Lite Flask](https://appseed.us/admin-dashboards/flask-dashboard-atlantis-dark) - product page
- [Atlantis Lite Flask](https://flask-atlantis-dark.appseed-srv1.com/) - LIVE Deployment
- [Atlantis Lite Flask](https://docs.appseed.us/products/flask-dashboards/atlantis-dark) - product documentation
- 👉 [Atlantis Lite Flask](https://appseed.us/admin-dashboards/flask-dashboard-atlantis-dark) - product page
- 👉 [Atlantis Lite Flask](https://flask-atlantis-dark.appseed-srv1.com/) - LIVE Deployment
- 👉 [Atlantis Lite Flask](https://docs.appseed.us/products/flask-dashboards/atlantis-dark) - product documentation

<br />

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

> Get the code
```bash
$ git clone https://github.com/app-generator/flask-dashboard-atlantis-dark.git
$ cd flask-dashboard-atlantis-dark
$ git clone https://github.com/app-generator/flask-atlantis-dark.git
$ cd flask-atlantis-dark
```

> Start the app in Docker
```bash
$ docker-compose pull # download dependencies
$ docker-compose build # local set up
$ docker-compose up -d # start the app
$ docker-compose up --build
```

Visit `http://localhost:85` in your browser. The app should be up & running.
Expand All @@ -50,12 +47,12 @@ 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
$ git clone https://github.com/app-generator/flask-dashboard-atlantis-dark.git
$ cd flask-dashboard-atlantis-dark
$ git clone https://github.com/app-generator/flask-atlantis-dark.git
$ cd flask-atlantis-dark
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
Expand Down Expand Up @@ -93,7 +90,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 bellow:

Expand Down Expand Up @@ -166,7 +163,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 @@ -209,7 +206,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 All @@ -227,8 +224,8 @@ Steps to deploy on **Heroku**

```bash
$ # Clone the source code:
$ git clone https://github.com/app-generator/flask-dashboard-atlantis-dark.git
$ cd flask-dashboard-atlantis-dark
$ git clone https://github.com/app-generator/flask-atlantis-dark.git
$ cd flask-atlantis-dark
$
$ # Check Heroku CLI is installed
$ heroku -v
Expand Down Expand Up @@ -292,7 +289,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
8 changes: 4 additions & 4 deletions apps/authentication/forms.py
Expand Up @@ -4,14 +4,14 @@
"""

from flask_wtf import FlaskForm
from wtforms import TextField, PasswordField
from wtforms import StringField, PasswordField
from wtforms.validators import Email, DataRequired

# login and registration


class LoginForm(FlaskForm):
username = TextField('Username',
username = StringField('Username',
id='username_login',
validators=[DataRequired()])
password = PasswordField('Password',
Expand All @@ -20,10 +20,10 @@ class LoginForm(FlaskForm):


class CreateAccountForm(FlaskForm):
username = TextField('Username',
username = StringField('Username',
id='username_create',
validators=[DataRequired()])
email = TextField('Email',
email = StringField('Email',
id='email_create',
validators=[DataRequired(), Email()])
password = PasswordField('Password',
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,7 +1,7 @@
{
"name": "flask-dashboard-atlantis-dark",
"mastertemplate": "boilerplate-code-flask-dashboard",
"version": "1.0.4",
"version": "1.0.5",
"description": "Template project - Flask Boilerplate Code",
"repository": {
"type": "git",
Expand Down
12 changes: 6 additions & 6 deletions requirements.txt
@@ -1,12 +1,12 @@
flask==2.0.1
flask==2.0.2
flask_login==0.5.0
flask_migrate==3.1.0
flask_wtf==0.15.1
WTForms==2.3.3
WTForms==3.0.1
flask_wtf==1.0.0
flask_sqlalchemy==2.5.1
sqlalchemy==1.4.23
sqlalchemy==1.4.29
email_validator==1.1.3
python-decouple==3.4
python-decouple==3.5
gunicorn==20.1.0
jinja2==3.0.1
jinja2==3.0.3
flask-restx==0.5.1

0 comments on commit 538e204

Please sign in to comment.