Skip to content

Commit e6772de

Browse files
author
App Generator
committed
Update README - before coding the feature
1 parent 75a74c6 commit e6772de

File tree

3 files changed

+25
-79
lines changed

3 files changed

+25
-79
lines changed

CHANGELOG.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# Change Log
22

3-
## [1.0.1] 2021-01-19
4-
### Improvements
3+
## [0.0.1] 2021-04-05
4+
### Initial Fork
55

6-
- Rename project to standard
7-
- Highlight sidebar based on the selected page
8-
- [Atlantis Lite](https://github.com/themekita/Atlantis-Lite): 2021-01-05 Snapshot
9-
10-
## [1.0.0] 2020-09-28
11-
### Initial Release
12-
13-
- Update Licensing information
14-
- Add CHANGELOG.md to track all changes
6+
- No feature coded

README.md

Lines changed: 16 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,36 @@
1-
# [Jinja Template](https://appseed.us/jinja-template) - **[Atlantis Lite](https://appseed.us/admin-dashboards/flask-dashboard-atlantis-dark)**
1+
# Flask Database Sample
22

3-
> Seed project coded in Flask/Jinja on top of Atlantis Lite (free version) - Features:
3+
Flask Sample project that provides an integration of SQLAlchemy ORM on top of a simple Flask Codebase. This project might help beginners to code a `real` project on top of Flask. For newcomers, Flask is a lightweight web application framework written in Python. By using a database in our project, we can have a persistent data layer that can be reused and updated according to application requirements.
44

55
<br />
66

7-
- UI Kit: **[Atlantis Lite](https://appseed.us/admin-dashboards/flask-dashboard-atlantis-dark)** (Free Version) by **ThemeKita**
8-
- Render Engine: [Jinja2](https://jinja.palletsprojects.com/)
9-
- Framework: Flask (no database, no hard dependencies)
7+
> Features
8+
9+
- Simple Flask codebase built with `best-practices` in mind
10+
- DBMS: SQLite Storage
11+
- DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
12+
- Permissive MIT License - allows unlimited copies for hobby and commercial products
1013
- Free support via **Github** and [Discord](https://discord.gg/fZC6hup).
1114

1215
<br />
1316

1417
> Links
1518
16-
- [Jinja Atlantis Dark](https://appseed.us/jinja-template/jinja-template-atlantis-dark) - Product page
17-
- [Jinja Atlantis Dark - Demo](https://jinja-atlantis-dark.appseed-srv1.com/) - LIVE Demo
18-
- [Atlantis Lite - UI Docs](https://atlantis-lite.appseed.us/) - how to customize the UI
19-
20-
<br />
21-
22-
## **[Atlantis Lite](https://appseed.us/admin-dashboards/flask-dashboard-atlantis-dark)**
23-
24-
**Atlantis Lite** is a free bootstrap 4 admin dashboard that is beautifully and elegantly designed to display various metrics, numbers or data visualization. Atlantis Lite admin dashboard has 2 layouts, many plugins and UI components to help developers create dashboards quickly and effectively so they can save development time and also help users to make the right and fast decisions based on existing data.
19+
- [Atlantis Lite Flask](https://appseed.us/admin-dashboards/flask-dashboard-atlantis-dark) - A full-featured Flask starter
20+
- [Jinja Atlantis Dark - Demo](https://flask-atlantis-dark.appseed-srv1.com/) - LIVE Demo
2521

2622
<br />
2723

28-
![Template Jinja2 Theme - Template project provided by AppSeed.](https://raw.githubusercontent.com/app-generator/jinja-template-atlantis-dark/master/media/jinja-template-atlantis-dark-screen.png)
24+
![Flask Database - Open-source sample provided by AppSeed.](https://raw.githubusercontent.com/app-generator/flask-dashboard-atlantis-dark/master/media/flask-dashboard-atlantis-dark-screen.png)
2925

3026
<br />
3127

3228
## Build from sources
3329

3430
```bash
3531
$ # Clone the sources
36-
$ git clone https://github.com/app-generator/jinja-template-atlantis-dark.git
37-
$ cd jinja-template-atlantis-dark
32+
$ git clone https://github.com/app-generator/flask-database-sample.git
33+
$ cd flask-database-sample
3834
$
3935
$ # Virtualenv modules installation (Unix based systems)
4036
$ virtualenv env
@@ -123,8 +119,8 @@ The steps to start the template using Docker:
123119
> Get the code
124120
125121
```bash
126-
$ git clone https://github.com/app-generator/jinja-template-atlantis-dark.git
127-
$ cd jinja-template-atlantis-dark
122+
$ git clone https://github.com/app-generator/flask-database-sample.git
123+
$ cd flask-database-sample
128124
```
129125

130126
> Start the app in Docker
@@ -137,53 +133,11 @@ Visit `http://localhost:5005` in your browser. The app should be up & running.
137133

138134
<br />
139135

140-
### [Gunicorn](https://gunicorn.org/)
141-
---
142-
143-
Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.
144-
145-
> Install using pip
146-
147-
```bash
148-
$ pip install gunicorn
149-
```
150-
> Start the app using gunicorn binary
151-
152-
```bash
153-
$ gunicorn --bind 0.0.0.0:8001 run:app
154-
Serving on http://localhost:8001
155-
```
156-
157-
Visit `http://localhost:8001` in your browser. The app should be up & running.
158-
159-
<br />
160-
161-
### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/)
162-
---
163-
164-
Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.
165-
166-
> Install using pip
167-
168-
```bash
169-
$ pip install waitress
170-
```
171-
> Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html)
172-
173-
```bash
174-
$ waitress-serve --port=8001 run:app
175-
Serving on http://localhost:8001
176-
```
177-
178-
Visit `http://localhost:8001` in your browser. The app should be up & running.
179-
180-
<br />
181-
182136
## Credits & Links
183137

184138
- [Flask Framework](https://www.palletsprojects.com/p/flask/) - The official website
185139

186140
<br />
187141

188142
---
189-
[Jinja Template](https://appseed.us/jinja-template) **[Atlantis Lite](https://appseed.us/admin-dashboards/flask-dashboard-atlantis-dark)** - Provided by **AppSeed** [Web App Generator](https://appseed.us/app-generator).
143+
Flask Database Sample - Open-source sample provided by **AppSeed** [App Generator](https://appseed.us/app-generator).

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
2-
"name": "jinja-template-atlantis-dark",
3-
"mastertemplate": "theme-jinja2",
4-
"version": "1.0.1",
5-
"description": "Template project - Flask/Jinja2 Theme",
2+
"name": "flask-database-sample",
3+
"mastertemplate": "jinja-atlantis-dark",
4+
"version": "0.0.1",
5+
"description": "Flask Database - Open-source Sample, provided by AppSeed.",
66
"scripts": {},
77
"repository": {
88
"type": "git",
9-
"url": "https://github.com/app-generator/jinja-template-atlantis-dark"
9+
"url": "https://github.com/app-generator/flask-database-sample"
1010
},
1111
"bugs": {
12-
"url": "https://github.com/app-generator/jinja-template-atlantis-dark/issues",
12+
"url": "https://github.com/app-generator/flask-database-sample/issues",
1313
"email": "support@appseed.us"
1414
},
1515
"author": "AppSeed App Generator <support@appseed.us> (https://appseed.us)",

0 commit comments

Comments
 (0)