Release v2.0.9 - UPD Codebase

.gitignore

@@ -0,0 +1,15 @@
+*.pyc
+*.DS_Store
+*.egg*
+/dist/
+/.idea
+/docs/_build/
+/node_modules/
+build/
+env
+/staticfiles/
+
+#src
+*.sqlite*
+
+.env

CHANGELOG.md

@@ -0,0 +1,127 @@
+# Change Log
+
+## [2.0.9] 2023-03-22
+### Changes
+
+- Design: [Django Admin Soft](https://github.com/app-generator/django-admin-soft-dashboard) `v1.0.10`
+- DOCS Update (readme). New sections:
+  - `How to customize the theme`
+  - Render deployment
+- Configure the project to use `home/templates`
+- Added `custom-index` sample
+- `Fix Docker` Execution
+  - `Update Settings`: ALLOWED_HOSTS, CSRF_TRUSTED_ORIGINS `sections`
+
+## [2.0.8] 2022-06-06
+### Improvements
+
+- Use generated version
+  - Timestamp: `2022-06-06 13:56`
+  - Build ID: `55e49700-ed76-4c12-8d8a-e063f97f89e5`
+
+## [2.0.7] 2022-06-06
+
+- Tag latest `manual` coded version 
+
+## [2.0.6] 2021-11-28 
+### Improvements
+
+- [x] `Data Tables` - manages paginated information
+  - [x] Data load via `admin`
+  - [x] Pagination, Inline edit via Ajax
+  - [x] Simple Search
+
+## [2.0.5] 2021-10-13 
+### Improvements
+
+- Improved Authentication: 
+  - Extended user model 
+  - Password reset 
+  - (Optional) Email confirmation on register
+- New user Fields: all information presented in the settings page:
+  - First, Last Name
+  - Birthday, Gender, Email, Phone   
+  - Address, Number, City, ZIP
+  - User Photo
+
+## [2.0.4] 2021-09-15 
+### Improvements
+
+- Codebase update
+  - `assets` & `templates` moved to `apps` folder
+  - `apps/base` renamed to `apps/home`
+
+## [2.0.3] 2021-09-14 
+### Improvements & Fixes
+
+- Patch (Minor) Bug: UI Notification Page
+  - Popups were dead.
+- Gulp Tooling: Minor improvement
+  - `core/static/assets/gulpfile.js`
+
+## [2.0.2] 2021-09-07
+### Fixes
+
+- Patch [#16](https://github.com/app-generator/boilerplate-code-django-dashboard/issues/16): Minor issue in Docker
+
+## [2.0.1] 2021-09-07
+### Improvements & Fixes
+
+- Better Code formatting
+- Improved Files organization
+- Optimize imports
+- Docker Scripts Update
+- Patch 500 Error when authenticated users access `admin` path (no slash at the end)
+
+## [2.0.0] 2021-09-01
+### Improvements
+
+- Dependencies update (all packages) 
+  - Django==3.2.6 (latest stable version)
+
+## [1.0.5] 2021-08-27
+### Improvements
+
+- Bump UI - [Volt Dashboard v1.4.1](https://github.com/themesberg/volt-bootstrap-5-dashboard/releases) 
+- Added Gulp SCSS compilation scripts
+  - Help can be found on README -> `Recompile CSS` section
+
+## [1.0.4] 2021-01-04
+### Bug fixing
+
+- Read properly the `.env` variables. Impacted file(s):
+    - Impacted file: **core/settings.py**
+
+## [1.0.3] 2021-01-01
+### Bug fixing, Improvements
+
+- Routing - remove a duplicate rule
+    - `admin` rule (no slash at the end)
+
+- Auth forms
+    - Login Page - update label
+    - Registration - hide the form on success
+
+- Unreported Bug - Left menu selection based on the current page. Modified files:
+    - app\views.py
+    - core\templates\includes\sidebar-rtl.html
+
+- Patch #4 - Whitenoise Fix - Wrong positioning in 'core/settings.py'
+    - WhiteNoiseMiddleware must be positioned right after SecurityMiddleware
+    - Impacted file: **core/settings.py** / MIDDLEWARE section
+
+## [1.0.2] 2020-06-18
+### Bug fixing, Improvements
+
+- Patch #2 - Error when access `admin` path (no trailing slash)
+
+## [1.0.1] 2020-05-30
+### Bug fixing, Improvements
+
+- Add CHANGELOG.md to track all changes
+- Patch #1 - Error-404.html not used in all contexts
+- Rename error pages: error-40X become page-40X
+- Update LICENSE file - added more information regarding the app usage
+
+## [1.0.0] 2020-02-07
+### Initial Release

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.9
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+COPY requirements.txt .
+# install python dependencies
+RUN pip install --upgrade pip
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+# running migrations
+RUN python manage.py migrate
+
+# gunicorn
+CMD ["gunicorn", "--config", "gunicorn-cfg.py", "core.wsgi"]

LICENSE.md

@@ -0,0 +1,32 @@
+# MIT License
+
+Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
+
+<br />
+
+## Licensing Information
+
+<br />
+
+| Item | - |
+| ---------------------------------- | --- |
+| License Type | MIT  |
+| Use for print | **YES** |
+| Create single personal website/app | **YES** |
+| Create single website/app for client | **YES** |
+| Create multiple website/apps for clients | **YES** |
+| Create multiple SaaS applications | **YES** |
+| End-product paying users | **YES** |
+| Product sale | **YES** |
+| Remove footer credits | **YES** |
+| --- | --- |
+| Remove copyright mentions from source code | NO |
+| Production deployment assistance | NO |
+| Create HTML/CSS template for sale | NO |
+| Create Theme/Template for CMS for sale | NO |
+| Separate sale of our UI Elements | NO |
+
+<br />
+
+---
+For more information regarding licensing, please contact the AppSeed Service < *support@appseed.us* >

README.md

@@ -1 +1,196 @@
-# boilerplate-code-django-dashboard
+# [Boilerplate Django Dashboard](https://appseed.us/boilerplate-code/django-dashboard/)
+
+Reference codebase used by `AppSeed` in all Django [Dashboard](https://appseed.us/admin-dashboards/django/) starters - the product uses an amazing design crafted by `Creative-Tim`.
+
+- 👉 [Boilerplate Django Dashboard](https://appseed.us/boilerplate-code/django-dashboard/) - `Product page`
+- 👉 [Boilerplate Django Dashboard](https://django-soft-dash.onrender.com/) - `LIVE Demo`
+- 👉 Free [Support](https://appseed.us/support/) via `Email` & `Discord`
+
+<br />
+
+> Features: 
+
+- ✅ `Up-to-date Dependencies`
+- ✅ Theme: [Django Admin Soft](https://github.com/app-generator/django-admin-soft-dashboard), designed by [Creative-Tim](https://www.creative-tim.com/product/soft-ui-dashboard?AFFILIATE=128200)
+  - `can be used in any Django project` (new or legacy)
+- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
+- 🚀 `Deployment` 
+  - `CI/CD` flow via `Render`
+  - [Django Soft - Go LIVE](https://www.youtube.com/watch?v=1QVdQVSkUCI) - `video presentation`
+
+<br />
+
+![Django Admin Soft - Template project for Django provided by AppSeed.](https://user-images.githubusercontent.com/51070104/215729207-5cce250e-54da-4712-89a9-c1fd6b0a149e.png)
+
+<br />
+
+## Start with `Docker`
+
+> 👉 **Step 1** - Download the code from the GH repository (using `GIT`) 
+
+```bash
+$ git clone https://github.com/app-generator/boilerplate-code-django-dashboard.git
+$ cd boilerplate-code-django-dashboard
+```
+
+<br />
+
+> 👉 **Step 2** - Start the APP in `Docker`
+
+```bash
+$ docker-compose up --build 
+```
+
+Visit `http://localhost:5085` in your browser. The app should be up & running.
+
+<br />
+
+## Manual Build 
+
+> 👉 Download the code  
+
+```bash
+$ git clone https://github.com/app-generator/boilerplate-code-django-dashboard.git
+$ cd boilerplate-code-django-dashboard
+```
+
+<br />
+
+> 👉 Install modules via `VENV`  
+
+```bash
+$ virtualenv env
+$ source env/bin/activate
+$ pip install -r requirements.txt
+```
+
+<br />
+
+> 👉 Set Up Database
+
+```bash
+$ python manage.py makemigrations
+$ python manage.py migrate
+```
+
+<br />
+
+> 👉 Create the Superuser
+
+```bash
+$ python manage.py createsuperuser
+```
+
+<br />
+
+> 👉 Start the app
+
+```bash
+$ python manage.py runserver
+```
+
+At this point, the app runs at `http://127.0.0.1:8000/`. 
+
+<br />
+
+## Codebase structure
+
+The project is coded using a simple and intuitive structure presented below:
+
+```bash
+< PROJECT ROOT >
+   |
+   |-- core/                            
+   |    |-- settings.py                  # Project Configuration  
+   |    |-- urls.py                      # Project Routing
+   |
+   |-- home/
+   |    |-- views.py                     # APP Views 
+   |    |-- urls.py                      # APP Routing
+   |    |-- models.py                    # APP Models 
+   |    |-- tests.py                     # Tests  
+   |    |-- templates/                   # Theme Customisation 
+   |         |-- includes                # 
+   |              |-- custom-footer.py   # Custom Footer      
+   |     
+   |-- requirements.txt                  # Project Dependencies
+   |
+   |-- env.sample                        # ENV Configuration (default values)
+   |-- manage.py                         # Start the app - Django default start script
+   |
+   |-- ************************************************************************
+```
+
+<br />
+
+## How to Customize 
+
+When a template file is loaded in the controller, `Django` scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found. 
+The theme used to style this starter provides the following files: 
+
+```bash
+# This exists in ENV: LIB/admin_soft
+< UI_LIBRARY_ROOT >                      
+   |
+   |-- templates/                     # Root Templates Folder 
+   |    |          
+   |    |-- accounts/       
+   |    |    |-- login.html           # Sign IN Page
+   |    |    |-- register.html        # Sign UP Page
+   |    |
+   |    |-- includes/       
+   |    |    |-- footer.html          # Footer component
+   |    |    |-- sidebar.html         # Sidebar component
+   |    |    |-- navigation.html      # Navigation Bar
+   |    |    |-- scripts.html         # Scripts Component
+   |    |
+   |    |-- layouts/       
+   |    |    |-- base.html            # Masterpage
+   |    |    |-- base-fullscreen.html # Masterpage for Auth Pages
+   |    |
+   |    |-- pages/       
+   |         |-- index.html           # Dashboard page
+   |         |-- profile.html         # Settings  Page
+   |         |-- *.html               # All other pages
+   |    
+   |-- ************************************************************************
+```
+
+When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path. 
+
+> For instance, if we want to **customize the footer.html** these are the steps:
+
+- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app
+- ✅ `Step 2`: configure the project to use this new template directory
+  - `core/settings.py` TEMPLATES section
+- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
+  - Source PATH: `<YOUR_ENV>/LIB/admin_soft/includes/footer.html`
+  - Destination PATH: `<PROJECT_ROOT>home/templates/includes/footer.html`
+
+> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom footer` can be found at this location:
+
+`home/templates/includes/custom_footer.html` 
+
+By default, this file is unused because the `theme` expects `footer.html` (without the `custom-` prefix). 
+
+In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django. 
+
+In a similar way, all other files and components can be customized easily.
+
+<br />
+
+## Deploy on [Render](https://render.com/)
+
+- Create a Blueprint instance
+  - Go to https://dashboard.render.com/blueprints this link.
+- Click `New Blueprint Instance` button.
+- Connect your `repo` which you want to deploy.
+- Fill the `Service Group Name` and click on `Update Existing Resources` button.
+- After that your deployment will start automatically.
+
+At this point, the product should be LIVE.
+
+<br />
+
+---
+ [Django Boilerplate](https://appseed.us/boilerplate-code/django-dashboard/) - **Django** starter provided by **[AppSeed](https://appseed.us/)**