Skip to content

Commit 2e250d0

Browse files
author
App Generator
committed
Release v1.0.2 - Bump Codebase & Improvements
1 parent 2e36091 commit 2e250d0

File tree

3 files changed

+131
-5
lines changed

3 files changed

+131
-5
lines changed

‎CHANGELOG.md‎

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

3+
## [1.0.2] 2021-09-20
4+
### Improvements
5+
6+
- Bump Django Codebase to [v2.0.4](https://github.com/app-generator/boilerplate-code-django-dashboard/releases)
7+
- Dependencies update (all packages)
8+
- Use Django==3.2.6 (latest stable version)
9+
- Better Code formatting
10+
- Improved Files organization
11+
- Optimize imports
12+
- Docker Scripts Update
13+
- Tooling:
14+
- Gulp SASS compilation script
15+
- `Update README` - Recompile SCSS (new section)
16+
- Fixes:
17+
- Patch 500 Error when authenticated users access `admin` path (no slash at the end)
18+
- Patch [#16](https://github.com/app-generator/boilerplate-code-django-dashboard/issues/16): Minor issue in Docker
19+
320
## [1.0.1] 2021-01-15
421
### Improvements
522

‎README.md‎

Lines changed: 113 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Admin dashboard generated by AppSeed in **[Django](https://appseed.us/admin-dash
66

77
> Features
88
9+
- Up-to-date [dependencies](./requirements.txt): **Django 3.2.6 LTS**
10+
- [SCSS compilation](#recompile-css) via **Gulp**
911
- UI-Ready app, SQLite Database, Django Native ORM
1012
- Modular design, clean code-base
1113
- Session-Based Authentication, Forms validation
@@ -73,6 +75,114 @@ $ # Access the web app in browser: http://127.0.0.1:8000/
7375
7476
<br />
7577

78+
## Code-base structure
79+
80+
The project is coded using a simple and intuitive structure presented bellow:
81+
82+
```bash
83+
< PROJECT ROOT >
84+
|
85+
|-- core/ # Implements app configuration
86+
| |-- settings.py # Defines Global Settings
87+
| |-- wsgi.py # Start the app in production
88+
| |-- urls.py # Define URLs served by all apps/nodes
89+
|
90+
|-- apps/
91+
| |
92+
| |-- home/ # A simple app that serve HTML files
93+
| | |-- views.py # Serve HTML pages for authenticated users
94+
| | |-- urls.py # Define some super simple routes
95+
| |
96+
| |-- authentication/ # Handles auth routes (login and register)
97+
| | |-- urls.py # Define authentication routes
98+
| | |-- views.py # Handles login and registration
99+
| | |-- forms.py # Define auth forms (login and register)
100+
| |
101+
| |-- static/
102+
| | |-- <css, JS, images> # CSS files, Javascripts files
103+
| |
104+
| |-- templates/ # Templates used to render pages
105+
| |-- includes/ # HTML chunks and components
106+
| | |-- navigation.html # Top menu component
107+
| | |-- sidebar.html # Sidebar component
108+
| | |-- footer.html # App Footer
109+
| | |-- scripts.html # Scripts common to all pages
110+
| |
111+
| |-- layouts/ # Master pages
112+
| | |-- base-fullscreen.html # Used by Authentication pages
113+
| | |-- base.html # Used by common pages
114+
| |
115+
| |-- accounts/ # Authentication pages
116+
| | |-- login.html # Login page
117+
| | |-- register.html # Register page
118+
| |
119+
| |-- home/ # UI Kit Pages
120+
| |-- index.html # Index page
121+
| |-- 404-page.html # 404 page
122+
| |-- *.html # All other pages
123+
|
124+
|-- requirements.txt # Development modules - SQLite storage
125+
|
126+
|-- .env # Inject Configuration via Environment
127+
|-- manage.py # Start the app - Django default start script
128+
|
129+
|-- ************************************************************************
130+
```
131+
132+
<br />
133+
134+
> The bootstrap flow
135+
136+
- Django bootstrapper `manage.py` uses `core/settings.py` as the main configuration file
137+
- `core/settings.py` loads the app magic from `.env` file
138+
- Redirect the guest users to Login page
139+
- Unlock the pages served by *app* node for authenticated users
140+
141+
<br />
142+
143+
## Recompile CSS
144+
145+
To recompile SCSS files, follow this setup:
146+
147+
<br />
148+
149+
**Step #1** - Install tools
150+
151+
- [NodeJS](https://nodejs.org/en/) 12.x or higher
152+
- [Gulp](https://gulpjs.com/) - globally
153+
- `npm install -g gulp-cli`
154+
- [Yarn](https://yarnpkg.com/) (optional)
155+
156+
<br />
157+
158+
**Step #2** - Change the working directory to `assets` folder
159+
160+
```bash
161+
$ cd apps/static/assets
162+
```
163+
164+
<br />
165+
166+
**Step #3** - Install modules (this will create a classic `node_modules` directory)
167+
168+
```bash
169+
$ npm install
170+
// OR
171+
$ yarn
172+
```
173+
174+
<br />
175+
176+
**Step #4** - Edit & Recompile SCSS files
177+
178+
```bash
179+
$ gulp scss
180+
```
181+
182+
The generated file is saved in `static/assets/css` directory.
183+
184+
<br />
185+
76186
## Deployment
77187

78188
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/).
@@ -85,8 +195,8 @@ The application can be easily executed in a docker container. The steps:
85195
> Get the code
86196
87197
```bash
88-
$ git clone https://github.com/app-generator/django-dashboard-argon.git
89-
$ cd django-dashboard-argon
198+
$ git clone https://github.com/app-generator/django-dashboard-material.git
199+
$ cd django-dashboard-material
90200
```
91201

92202
> Start the app in Docker
@@ -95,7 +205,7 @@ $ cd django-dashboard-argon
95205
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
96206
```
97207

98-
Visit `http://localhost:5005` in your browser. The app should be up & running.
208+
Visit `http://localhost:85` in your browser. The app should be up & running.
99209

100210
<br />
101211

@@ -118,7 +228,6 @@ Serving on http://localhost:8001
118228

119229
Visit `http://localhost:8001` in your browser. The app should be up & running.
120230

121-
122231
<br />
123232

124233
### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/)

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "django-dashboard-argon",
33
"mastertemplate": "boilerplate-code-django-dashboard",
4-
"version": "1.0.1",
4+
"version": "1.0.2",
55
"description": "Template project - Django Boilerplate Code",
66
"scripts": {},
77
"repository": {

0 commit comments

Comments
 (0)