Release v1.0.2 - Bump Codebase + Improvements

app-generator · Sep 13, 2021 · 57ab480 · 57ab480
1 parent a8516af
commit 57ab480
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Change Log
 
+## [1.0.2] 2021-09-12
+### Improvements & Fixes
+
+- Bump Django Codebase to [v2.0.2](https://github.com/app-generator/boilerplate-code-django-dashboard/releases)
+  - Dependencies update (all packages)
+    - Use Django==3.2.6 (latest stable version)
+  - Better Code formatting
+  - Improved Files organization
+  - Optimize imports
+  - Docker Scripts Update 
+-Tooling:
+  - SASS compilation via Gulp  
+- Fixes: 
+  - Patch 500 Error when authenticated users access `admin` path (no slash at the end)
+  - Patch [#16](https://github.com/app-generator/boilerplate-code-django-dashboard/issues/16): Minor issue in Docker 
+
 ## [1.0.1] 2021-01-21
 
 - Bump UI: [Jinja Atlantis Dark](https://github.com/app-generator/jinja-atlantis-dark/releases) 1.0.1

diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@ Open-source dashboard generated by AppSeed in **Django** Framework. Atlantis Lit
 
 > Features
 
+- Up-to-date [dependencies](./requirements.txt): **Django 3.2.6 LTS**
 - UI-Ready app, SQLite Database, Django Native ORM
 - Modular design, clean code-base
 - Session-Based Authentication, Forms validation
@@ -74,7 +75,7 @@ $ # Access the web app in browser: http://127.0.0.1:8000/
 
 ## Code-base structure
 
-The project is coded using a simple and intuitive structure presented bellow:
+The project is coded using a simple and intuitive structure presented below:
 
 ```bash
 < PROJECT ROOT >
@@ -108,16 +109,17 @@ The project is coded using a simple and intuitive structure presented bellow:
    |     page-500.html                     # Error 404 page
    |       *.html                          # All other HTML pages
    |
-   |-- authentication/                     # Handles auth routes (login and register)
+   |-- apps/
+   |    |-- authentication/                # Handles auth routes (login and register)
+   |    |    |
+   |    |    |-- urls.py                   # Define authentication routes  
+   |    |    |-- views.py                  # Handles login and registration  
+   |    |    |-- forms.py                  # Define auth forms  
    |    |
-   |    |-- urls.py                        # Define authentication routes  
-   |    |-- views.py                       # Handles login and registration  
-   |    |-- forms.py                       # Define auth forms  
-   |
-   |-- app/                                # A simple app that serve HTML files
-   |    |
-   |    |-- views.py                       # Serve HTML pages for authenticated users
-   |    |-- urls.py                        # Define some super simple routes  
+   |    |-- app/                           # A simple app that serve HTML files
+   |         |
+   |         |-- views.py                  # Serve HTML pages for authenticated users
+   |         |-- urls.py                   # Define some super simple routes  
    |
    |-- requirements.txt                    # Development modules - SQLite storage
    |
@@ -138,6 +140,49 @@ The project is coded using a simple and intuitive structure presented bellow:
 
 <br />
 
+## Recompile CSS
+
+To recompile SCSS files, follow this setup:
+
+<br />
+
+**Step #1** - Install tools
+
+- [NodeJS](https://nodejs.org/en/) 12.x or higher
+- [Gulp](https://gulpjs.com/) - globally 
+    - `npm install -g gulp-cli`
+- [Yarn](https://yarnpkg.com/) (optional) 
+
+<br />
+
+**Step #2** - Change the working directory to `assets` folder
+
+```bash
+$ cd core/static/assets
+```
+
+<br />
+
+**Step #3** - Install modules (this will create a classic `node_modules` directory)
+
+```bash
+$ npm install
+// OR
+$ yarn
+```
+
+<br />
+
+**Step #4** - Edit & Recompile SCSS files 
+
+```bash
+$ gulp scss
+```
+
+The generated file is saved in `static/assets/css` directory.
+
+<br /> 
+
 ## Deployment
 
 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 +205,7 @@ $ cd django-dashboard-atlantis-dark
 $ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
 ```
 
-Visit `http://localhost:5005` in your browser. The app should be up & running.
+Visit `http://localhost:85` in your browser. The app should be up & running.
 
 <br />
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "django-dashboard-atlantis-dark",
     "mastertemplate": "boilerplate-code-django-dashboard",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "Template project - Django Boilerplate Code",
     "scripts": {},
     "repository": {