Skip to content

Commit 4507a77

Browse files
author
App Generator
committed
Release v1.0.1
1 parent fd1e111 commit 4507a77

File tree

3 files changed

+116
-79
lines changed

3 files changed

+116
-79
lines changed

‎CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Change Log
22

3+
## [1.0.1] 2021-01-20
4+
### Improvements
5+
6+
- Bump Django Codebase to [v2stable.0.1](https://github.com/app-generator/boilerplate-code-django-dashboard/releases)
7+
- Dependencies update (all packages)
8+
- Django==4.0.1
9+
- Settings update for Django 4.x
10+
- `New Parameter`: CSRF_TRUSTED_ORIGINS
11+
- [Origin header checking isn`t performed in older versions](https://docs.djangoproject.com/en/4.0/ref/settings/#csrf-trusted-origins)
12+
313
## Unreleased
414
### Bug fixes
515

‎README.md‎

Lines changed: 86 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,38 @@ Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django)** g
66

77
> Features
88
9-
- UI-Ready app, SQLite Database, Django Native ORM
10-
- Modular design, clean code-base
11-
- Session-Based Authentication, Forms validation
12-
- Deployment scripts: Docker, Gunicorn / Nginx
13-
- Support via **Github** and [Discord](https://discord.gg/fZC6hup).
9+
- `Up-to-date dependencies`
10+
- UI-Ready app, `SQLite Database`, Django Native ORM
11+
- `Session-Based authentication`, Forms validation
12+
- `Deployment`: **Docker**, Gunicorn / Nginx, HEROKU
13+
- Support via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup).
1414

1515
<br />
1616

1717
> Links
1818
19-
- [Django Dashboard Tabler](https://appseed.us/admin-dashboards/django-dashboard-tabler) - product page
20-
- [Django Dashboard Tabler](https://django-dashboard-tabler.appseed.us) - LIVE Deployment
21-
- [Django Dashboard Tabler](https://docs.appseed.us/products/django-dashboards/tabler) - product documentation
19+
- 👉 [Django Tabler](https://appseed.us/admin-dashboards/django-dashboard-tabler) - product page
20+
- 👉 [Django tabler](https://django-dashboard-tabler.appseed.us/) - LIVE App
2221

2322
<br />
2423

25-
## Want more? Go PRO!
24+
## ✨ Quick Start in `Docker`
2625

27-
PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Support** (via [Discord](https://discord.gg/fZC6hup))
26+
> Get the code
2827
29-
| [Django Datta PRO](https://appseed.us/admin-dashboards/django-dashboard-dattaable-pro) | [Django Soft PRO](https://appseed.us/product/django-soft-ui-dashboard-pro) | [Django Volt PRO](https://appseed.us/admin-dashboards/django-dashboard-volt-pro) |
30-
| --- | --- | --- |
31-
| [![Django Datta PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-dattaable-pro/master/media/django-dashboard-dattaable-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-dattaable-pro) | [![Django Soft PRO](https://user-images.githubusercontent.com/51070104/123547150-3f176300-d768-11eb-9359-ad6611e19a3a.png)](https://appseed.us/product/django-soft-ui-dashboard-pro) | [![Django Volt PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-volt-pro/master/media/django-dashboard-volt-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-volt-pro)
28+
```bash
29+
$ git clone https://github.com/app-generator/django-tabler.git
30+
$ cd django-tabler
31+
```
32+
33+
> Start the app in Docker
34+
35+
```bash
36+
$ docker-compose up --build
37+
```
38+
39+
Visit `http://localhost:85` in your browser. The app should be up & running.
3240

33-
<br />
3441
<br />
3542

3643
![Django Dashboard Tabler - Open-Source Web App.](https://raw.githubusercontent.com/app-generator/static/master/products/django-dashboard-tabler-screen.png)
@@ -41,8 +48,8 @@ PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Suppo
4148

4249
```bash
4350
$ # Get the code
44-
$ git clone https://github.com/app-generator/django-dashboard-tabler.git
45-
$ cd django-dashboard-tabler
51+
$ git clone https://github.com/app-generator/django-tabler.git
52+
$ cd django-tabler
4653
$
4754
$ # Virtualenv modules installation (Unix based systems)
4855
$ virtualenv env
@@ -69,34 +76,75 @@ $
6976
$ # Access the web app in browser: http://127.0.0.1:8000/
7077
```
7178

72-
<br />
73-
74-
## Deployment
75-
76-
The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
77-
78-
### [Docker](https://www.docker.com/) execution
79-
---
80-
81-
The application can be easily executed in a docker container. The steps:
79+
## ✨ Code-base structure
8280

83-
> Get the code
81+
The project is coded using a simple and intuitive structure presented bellow:
8482

8583
```bash
86-
$ git clone https://github.com/app-generator/django-dashboard-tabler.git
87-
$ cd django-dashboard-tabler
84+
< PROJECT ROOT >
85+
|
86+
|-- core/ # Implements app configuration
87+
| |-- settings.py # Defines Global Settings
88+
| |-- wsgi.py # Start the app in production
89+
| |-- urls.py # Define URLs served by all apps/nodes
90+
|
91+
|-- apps/
92+
| |
93+
| |-- home/ # A simple app that serve HTML files
94+
| | |-- views.py # Serve HTML pages for authenticated users
95+
| | |-- urls.py # Define some super simple routes
96+
| |
97+
| |-- authentication/ # Handles auth routes (login and register)
98+
| | |-- urls.py # Define authentication routes
99+
| | |-- views.py # Handles login and registration
100+
| | |-- forms.py # Define auth forms (login and register)
101+
| |
102+
| |-- static/
103+
| | |-- <css, JS, images> # CSS files, Javascripts files
104+
| |
105+
| |-- templates/ # Templates used to render pages
106+
| |-- includes/ # HTML chunks and components
107+
| | |-- navigation.html # Top menu component
108+
| | |-- sidebar.html # Sidebar component
109+
| | |-- footer.html # App Footer
110+
| | |-- scripts.html # Scripts common to all pages
111+
| |
112+
| |-- layouts/ # Master pages
113+
| | |-- base-fullscreen.html # Used by Authentication pages
114+
| | |-- base.html # Used by common pages
115+
| |
116+
| |-- accounts/ # Authentication pages
117+
| | |-- login.html # Login page
118+
| | |-- register.html # Register page
119+
| |
120+
| |-- home/ # UI Kit Pages
121+
| |-- index.html # Index page
122+
| |-- 404-page.html # 404 page
123+
| |-- *.html # All other pages
124+
|
125+
|-- requirements.txt # Development modules - SQLite storage
126+
|
127+
|-- .env # Inject Configuration via Environment
128+
|-- manage.py # Start the app - Django default start script
129+
|
130+
|-- ************************************************************************
88131
```
89132

90-
> Start the app in Docker
133+
<br />
91134

92-
```bash
93-
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
94-
```
135+
> The bootstrap flow
95136
96-
Visit `http://localhost:5005` in your browser. The app should be up & running.
137+
- Django bootstrapper `manage.py` uses `core/settings.py` as the main configuration file
138+
- `core/settings.py` loads the app magic from `.env` file
139+
- Redirect the guest users to Login page
140+
- Unlock the pages served by *app* node for authenticated users
97141

98142
<br />
99143

144+
## ✨ Deployment
145+
146+
The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
147+
100148
### [Gunicorn](https://gunicorn.org/)
101149
---
102150

@@ -140,24 +188,11 @@ Visit `http://localhost:8001` in your browser. The app should be up & running.
140188

141189
<br />
142190

143-
## Credits & Links
144-
145-
### [Django Admin Dashboards](https://appseed.us/admin-dashboards/django)
146-
147-
Index with UI-ready **admin dashboards** generated by the AppSeed platform in [Django Framework](https://www.djangoproject.com/).
148-
Start fast your next Django project by using functional admin dashboards enhanced with Database, ORM, authentication flow, helpers and deployment scripts.
149-
150-
### What is [Django](https://www.djangoproject.com/)
151-
152-
[Django](https://www.djangoproject.com/) is a Python-based free and open-source web framework, which follows the model-template-view architectural pattern. It is maintained by the Django Software Foundation, an independent organization established as a 501 non-profit. Django's primary goal is to ease the creation of complex, database-driven websites.
153-
154-
### [What is a dashboard](https://en.wikipedia.org/wiki/Dashboard_(business))
155-
156-
A dashboard is a set of pages that are easy to read and offer information to the user in real-time regarding his business. A dashboard usually consists of graphical representations of the current status and trends within an organization. Having a well-designed dashboard will give you the possibility to act and make informed decisions based on the data that your business provides - *definition provided by [Creative-Tim - Free Dashboard Templates](https://www.creative-tim.com/blog/web-design/free-dashboard-templates/?ref=appseed)*.
157-
158-
### [Tabler Dashboard](https://tabler.io/?ref=appseed)
191+
## ✨ Credits & Links
159192

160-
[Tabler Dashboard](https://tabler.io/?ref=appseed) is a open-source admin template crafted by Codecalm agency. It comes with the basic components and set of pre-built pages required to lay the foundation for any application. - provided by **CodeCalm**.
193+
- [Django](https://www.djangoproject.com/) - The official website
194+
- [Boilerplate Code](https://appseed.us/boilerplate-code) - Index provided by **AppSeed**
195+
- [Boilerplate Code](https://github.com/app-generator/boilerplate-code) - Index published on Github
161196

162197
<br />
163198

‎package.json‎

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,21 @@
11
{
2-
"name": "django-dashboard-light-blue",
3-
"version": "1.0.1",
4-
"description": "A simple UI-Ready Django boilerplate.",
5-
"scripts": {
6-
"lint": "eslint ."
7-
},
8-
"engines": {
9-
"node": "8.11.3"
10-
},
11-
"devDependencies": {
12-
"eslint": "5.0.0",
13-
"eslint-config-google": "0.9.1"
14-
},
15-
"repository": {
16-
"type": "git",
17-
"url": "https://github.com/app-generator/django-dashboard-light-blue"
18-
},
19-
"keywords": [
20-
"django",
21-
"admin-panel",
22-
"open-source"
23-
],
24-
"author": "AppSeed.us",
25-
"contributors": [
26-
"AppSeed Support <support@appseed.us>"
27-
],
28-
"license": "MIT"
29-
}
2+
"name": "django-tabler",
3+
"mastertemplate": "boilerplate-code-django-dashboard",
4+
"version": "1.0.1",
5+
"description": "Template project - Django Boilerplate Code",
6+
"scripts": {},
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/app-generator/django-tabler"
10+
},
11+
"bugs": {
12+
"url": "https://github.com/app-generator/django-tabler/issues",
13+
"email": "support@appseed.us"
14+
},
15+
"author": "AppSeed App Generator <support@appseed.us> (https://appseed.us)",
16+
"engines": {
17+
"node": ">=10.0.0"
18+
},
19+
"dependencies": {},
20+
"devDependencies": {}
21+
}

0 commit comments

Comments
 (0)