Skip to content

Commit 93e28fd

Browse files
author
App Generator
committed
Release v1.0.2
1 parent 34af190 commit 93e28fd

File tree

3 files changed

+96
-47
lines changed

3 files changed

+96
-47
lines changed

‎CHANGELOG.md‎

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

3+
## [1.0.2] 2021-12-02
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+
317
## [1.0.1] 2021-05-27
418
### Improvements
519

‎README.md‎

Lines changed: 81 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# [Django Light Bootstrap](https://appseed.us/admin-dashboards/django-dashboard-light)
22

3-
Admin dashboard generated by AppSeed in **Django** Framework. [Light Bootstrap Dashboard](https://appseed.us/admin-dashboards/django-dashboard-light) is Bootstrap 4 admin dashboard template designed to be beautiful and simple. It is built on top of Bootstrap 4 and it is fully responsive. It comes with a big colections of elements that will offer you multiple possibilities to create the app that best fits your needs. It can be used to create admin panels, project management systems, web applications backend, CMS or CRM.
3+
Admin dashboard generated by AppSeed in **Django** Framework. [Light Bootstrap Dashboard](https://appseed.us/admin-dashboards/django-dashboard-light) is a Bootstrap 4 admin dashboard template designed to be beautiful and simple. It is built on top of Bootstrap 4 and it is fully responsive. It comes with a big colections of elements that will offer you multiple possibilities to create the app that best fits your needs. It can be used to create admin panels, project management systems, web applications backend, CMS or CRM.
44

55
<br />
66

77
> Features
88
9+
- `Up-to-date dependencies`: **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
@@ -18,19 +20,32 @@ Admin dashboard generated by AppSeed in **Django** Framework. [Light Bootstrap D
1820
1921
- [Django Light Bootstrap](https://appseed.us/admin-dashboards/django-dashboard-light) - product page
2022
- [Django Light Bootstrap](https://django-light-bootstrap.appseed-srv1.com) - LIVE deployment
21-
- [Django Light Bootstrap](https://docs.appseed.us/products/django-dashboards/light-bootstrap-dashboard) - Product documentation
2223

2324
<br />
2425

25-
## Want more? Go PRO!
26+
## Quick Start in [Docker](https://www.docker.com/)
2627

27-
PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Support** (via [Discord](https://discord.gg/fZC6hup))
28+
> Get the code
29+
30+
```bash
31+
$ git clone https://github.com/app-generator/django-dashboard-light-bootstrap.git
32+
$ cd django-dashboard-light-bootstrap
33+
```
2834

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)
35+
> Start the app in Docker
36+
37+
```bash
38+
$ docker-compose pull # download dependencies
39+
$ docker-compose build # local set up
40+
$ docker-compose up -d # start the app
41+
```
42+
43+
Visit `http://localhost:85` in your browser. The app should be up & running.
3244

3345
<br />
46+
47+
![Django Dashboard Argon - Template project provided by AppSeed.](https://raw.githubusercontent.com/app-generator/django-dashboard-argon/master/media/django-dashboard-argon-screen.png)
48+
3449
<br />
3550

3651
![Django Dashboard - Light Bootstrap - Template project provided by AppSeed.](https://raw.githubusercontent.com/app-generator/django-dashboard-light-bootstrap/master/media/django-dashboard-light-bootstrap-screen.png)
@@ -79,50 +94,49 @@ The project is coded using a simple and intuitive structure presented bellow:
7994
```bash
8095
< PROJECT ROOT >
8196
|
82-
|-- core/ # Implements app logic and serve the static assets
83-
| |-- settings.py # Django app bootstrapper
97+
|-- core/ # Implements app configuration
98+
| |-- settings.py # Defines Global Settings
8499
| |-- wsgi.py # Start the app in production
85100
| |-- urls.py # Define URLs served by all apps/nodes
101+
|
102+
|-- apps/
103+
| |
104+
| |-- home/ # A simple app that serve HTML files
105+
| | |-- views.py # Serve HTML pages for authenticated users
106+
| | |-- urls.py # Define some super simple routes
107+
| |
108+
| |-- authentication/ # Handles auth routes (login and register)
109+
| | |-- urls.py # Define authentication routes
110+
| | |-- views.py # Handles login and registration
111+
| | |-- forms.py # Define auth forms (login and register)
86112
| |
87113
| |-- static/
88114
| | |-- <css, JS, images> # CSS files, Javascripts files
89115
| |
90116
| |-- templates/ # Templates used to render pages
91-
| |
92117
| |-- includes/ # HTML chunks and components
93118
| | |-- navigation.html # Top menu component
94119
| | |-- sidebar.html # Sidebar component
95120
| | |-- footer.html # App Footer
96121
| | |-- scripts.html # Scripts common to all pages
97122
| |
98-
| |-- layouts/ # Master pages
99-
| | |-- base-fullscreen.html # Used by Authentication pages
100-
| | |-- base.html # Used by common pages
123+
| |-- layouts/ # Master pages
124+
| | |-- base-fullscreen.html # Used by Authentication pages
125+
| | |-- base.html # Used by common pages
101126
| |
102-
| |-- accounts/ # Authentication pages
103-
| | |-- login.html # Login page
104-
| | |-- register.html # Register page
127+
| |-- accounts/ # Authentication pages
128+
| | |-- login.html # Login page
129+
| | |-- register.html # Register page
105130
| |
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
131+
| |-- home/ # UI Kit Pages
132+
| |-- index.html # Index page
133+
| |-- 404-page.html # 404 page
134+
| |-- *.html # All other pages
110135
|
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
136+
|-- requirements.txt # Development modules - SQLite storage
116137
|
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
138+
|-- .env # Inject Configuration via Environment
139+
|-- manage.py # Start the app - Django default start script
126140
|
127141
|-- ************************************************************************
128142
```
@@ -138,32 +152,53 @@ The project is coded using a simple and intuitive structure presented bellow:
138152

139153
<br />
140154

141-
## Deployment
155+
## Recompile CSS
142156

143-
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/).
157+
To recompile SCSS files, follow this setup:
144158

145-
### [Docker](https://www.docker.com/) execution
146-
---
159+
<br />
147160

148-
The application can be easily executed in a docker container. The steps:
161+
**Step #1** - Install tools
149162

150-
> Get the code
163+
- [NodeJS](https://nodejs.org/en/) 12.x or higher
164+
- [Gulp](https://gulpjs.com/) - globally
165+
- `npm install -g gulp-cli`
166+
- [Yarn](https://yarnpkg.com/) (optional)
167+
168+
<br />
169+
170+
**Step #2** - Change the working directory to `assets` folder
151171

152172
```bash
153-
$ git clone https://github.com/app-generator/django-dashboard-light-bootstrap.git
154-
$ cd django-dashboard-light-bootstrap
173+
$ cd apps/static/assets
155174
```
156175

157-
> Start the app in Docker
176+
<br />
177+
178+
**Step #3** - Install modules (this will create a classic `node_modules` directory)
158179

159180
```bash
160-
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
181+
$ npm install
182+
// OR
183+
$ yarn
161184
```
162185

163-
Visit `http://localhost:5005` in your browser. The app should be up & running.
164-
165186
<br />
166187

188+
**Step #4** - Edit & Recompile SCSS files
189+
190+
```bash
191+
$ gulp scss
192+
```
193+
194+
The generated file is saved in `static/assets/css` directory.
195+
196+
<br />
197+
198+
## Deployment
199+
200+
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/).
201+
167202
### [Gunicorn](https://gunicorn.org/)
168203
---
169204

‎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-light-bootstrap",
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)