Skip to content

Commit d4d41eb

Browse files
author
App Generator
committed
Release v1.0.2
1 parent 89681a5 commit d4d41eb

File tree

3 files changed

+107
-51
lines changed

3 files changed

+107
-51
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-10-07
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] 2020-06-08
421
### Improvements
522

‎README.md

Lines changed: 70 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -79,50 +79,49 @@ The project is coded using a simple and intuitive structure presented bellow:
7979
```bash
8080
< PROJECT ROOT >
8181
|
82-
|-- core/ # Implements app logic and serve the static assets
83-
| |-- settings.py # Django app bootstrapper
82+
|-- core/ # Implements app configuration
83+
| |-- settings.py # Defines Global Settings
8484
| |-- wsgi.py # Start the app in production
8585
| |-- urls.py # Define URLs served by all apps/nodes
86+
|
87+
|-- apps/
88+
| |
89+
| |-- home/ # A simple app that serve HTML files
90+
| | |-- views.py # Serve HTML pages for authenticated users
91+
| | |-- urls.py # Define some super simple routes
92+
| |
93+
| |-- authentication/ # Handles auth routes (login and register)
94+
| | |-- urls.py # Define authentication routes
95+
| | |-- views.py # Handles login and registration
96+
| | |-- forms.py # Define auth forms (login and register)
8697
| |
8798
| |-- static/
8899
| | |-- <css, JS, images> # CSS files, Javascripts files
89100
| |
90101
| |-- templates/ # Templates used to render pages
91-
| |
92102
| |-- includes/ # HTML chunks and components
93103
| | |-- navigation.html # Top menu component
94104
| | |-- sidebar.html # Sidebar component
95105
| | |-- footer.html # App Footer
96106
| | |-- scripts.html # Scripts common to all pages
97107
| |
98-
| |-- layouts/ # Master pages
99-
| | |-- base-fullscreen.html # Used by Authentication pages
100-
| | |-- base.html # Used by common pages
108+
| |-- layouts/ # Master pages
109+
| | |-- base-fullscreen.html # Used by Authentication pages
110+
| | |-- base.html # Used by common pages
101111
| |
102-
| |-- accounts/ # Authentication pages
103-
| | |-- login.html # Login page
104-
| | |-- register.html # Register page
112+
| |-- accounts/ # Authentication pages
113+
| | |-- login.html # Login page
114+
| | |-- register.html # Register page
105115
| |
106-
| index.html # The default page
107-
| page-404.html # Error 404 page
108-
| page-500.html # Error 404 page
109-
| *.html # All other HTML pages
116+
| |-- home/ # UI Kit Pages
117+
| |-- index.html # Index page
118+
| |-- 404-page.html # 404 page
119+
| |-- *.html # All other pages
110120
|
111-
|-- authentication/ # Handles auth routes (login and register)
112-
| |
113-
| |-- urls.py # Define authentication routes
114-
| |-- views.py # Handles login and registration
115-
| |-- forms.py # Define auth forms
121+
|-- requirements.txt # Development modules - SQLite storage
116122
|
117-
|-- app/ # A simple app that serve HTML files
118-
| |
119-
| |-- views.py # Serve HTML pages for authenticated users
120-
| |-- urls.py # Define some super simple routes
121-
|
122-
|-- requirements.txt # Development modules - SQLite storage
123-
|
124-
|-- .env # Inject Configuration via Environment
125-
|-- manage.py # Start the app - Django default start script
123+
|-- .env # Inject Configuration via Environment
124+
|-- manage.py # Start the app - Django default start script
126125
|
127126
|-- ************************************************************************
128127
```
@@ -138,6 +137,49 @@ The project is coded using a simple and intuitive structure presented bellow:
138137

139138
<br />
140139

140+
## Recompile CSS
141+
142+
To recompile SCSS files, follow this setup:
143+
144+
<br />
145+
146+
**Step #1** - Install tools
147+
148+
- [NodeJS](https://nodejs.org/en/) 12.x or higher
149+
- [Gulp](https://gulpjs.com/) - globally
150+
- `npm install -g gulp-cli`
151+
- [Yarn](https://yarnpkg.com/) (optional)
152+
153+
<br />
154+
155+
**Step #2** - Change the working directory to `assets` folder
156+
157+
```bash
158+
$ cd apps/static/assets
159+
```
160+
161+
<br />
162+
163+
**Step #3** - Install modules (this will create a classic `node_modules` directory)
164+
165+
```bash
166+
$ npm install
167+
// OR
168+
$ yarn
169+
```
170+
171+
<br />
172+
173+
**Step #4** - Edit & Recompile SCSS files
174+
175+
```bash
176+
$ gulp scss
177+
```
178+
179+
The generated file is saved in `static/assets/css` directory.
180+
181+
<br />
182+
141183
## Deployment
142184

143185
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/).
@@ -160,7 +202,7 @@ $ cd django-dashboard-coreui
160202
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
161203
```
162204

163-
Visit `http://localhost:5005` in your browser. The app should be up & running.
205+
Visit `http://localhost:85` in your browser. The app should be up & running.
164206

165207
<br />
166208

‎package.json

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
11
{
2-
"name": "django-dashboard-coreui",
3-
"mastertemplate": "boilerplate-code-django-dashboard",
4-
"version": "1.0.1",
5-
"description": "Template project - Django Boilerplate Code",
6-
"scripts": {
7-
},
8-
"repository": {
9-
"type": "git",
10-
"url": "https://github.com/app-generator/django-dashboard-coreui"
11-
},
12-
"bugs": {
13-
"url": "https://github.com/app-generator/django-dashboard-coreui/issues",
14-
"email": "support@appseed.us"
15-
},
16-
"author": "AppSeed App Generator <support@appseed.us> (https://appseed.us)",
17-
"engines": {
18-
"node": ">=10.0.0"
19-
},
20-
"dependencies": {
21-
},
22-
"devDependencies": {
23-
}
24-
}
2+
"name": "django-dashboard-coreui",
3+
"mastertemplate": "boilerplate-code-django-dashboard",
4+
"version": "1.0.2",
5+
"description": "Template project - Django Boilerplate Code",
6+
"scripts": {},
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/app-generator/django-dashboard-coreui"
10+
},
11+
"bugs": {
12+
"url": "https://github.com/app-generator/django-dashboard-coreui/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)