v1.0.1 - Bug fixing, Improvements

- Add CHANGELOG.md to track all changes - Patch - Error-404.html not used in all contexts - Update LICENSE file - added more information regarding the app usage
app-generator · May 31, 2020 · eb7affd · eb7affd
1 parent 49d190b
commit eb7affd
Show file tree

Hide file tree

Showing 3 changed files with 116 additions and 174 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Change Log
+
+## [1.0.1] 2020-05-31
+### Bug fixing, Improvements
+- Add CHANGELOG.md to track all changes
+- Patch - Error-404.html not used in all contexts
+- Update LICENSE file - added more information regarding the app usage
+
+## [1.0.0] 2020-05-01
+### Initial Release
diff --git a/LICENSE.md b/LICENSE.md
@@ -6,27 +6,28 @@ Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
 
 ## Licensing Information
 
+All commercial web apps (including this one) provided by AppSeed are released under two configurations:
+
 <br />
 
-| Item | - | - |
-| ---------------------------------- | --- | --- |
-| License Type | Personal | Developer |
-| Use for print | **YES** | **YES** |
-| Create single personal website/app | **YES** | **YES** |
-| Create single website/app for client | **YES** | **YES** |
-| --- | --- |
-| Create multiple website/apps for clients | NO | **YES** |
-| Create SaaS application | NO | **YES** |
-| Create HTML/CSS template for sale | NO | NO |
-| Create Theme/Template for CMS for sale | NO | NO |
-| Product resale | NO | NO |
-| Separate sale of our UI Elements | NO | NO |
-| Create online/offline generators based on our products | NO | NO |
+### [Personal License](https://github.com/app-generator/license-personal)
+
+> For full information please access [Personal License](https://github.com/app-generator/license-personal)
+
+- Create single personal website/app
+- Create single website/app for client
 
 <br />
 
-## Note for freelancers and agencies
+### [Developer License](https://github.com/app-generator/license-developer)
 
-You can charge your client to create an end product if you have a Personal license. But if you have multiple clients, or multiple projects, you will need a Developer license.
+> For full information please access [Developer License](https://github.com/app-generator/license-developer)
+
+- Create multiple personal websites/apps
+- Create multiple websites/apps for clients
+- Create single SaaS application
+
+<br />
 
-For more information regarding licensing, please contact the AppSeed Service < support @ appseed.us >
+---
+For more information regarding licensing, please contact the AppSeed Service < *support@appseed.us* >
diff --git a/README.md b/README.md
@@ -1,129 +1,29 @@
-# [Django Dashboard StarAdmin PRO](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro)
+# [Django StarAdmin PRO](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro)
 
-**Commercial** Admin Dashboard coded in [Django Framework](https://www.djangoproject.com/) on top of **[StarAdmin Dashboard](https://django-dashboard-staradmin-pro.appseed.us/login/)** design (PRO Version) designed by **BootstrapDash** Agency - product generated by AppSeed.
-
-<br />
-
-## Dashboard Features
+> Commercial product - **Django Dashboard** coded on top of **StarAdmin PRO** crafted by **BootstrapDash** - Features:
 
+- Sample UI Kit: **StarAdmin PRO** provided by **BootstrapDash**
 - UI-Ready app, SQLite Database, Django Native ORM
 - Modular design, clean code-base
 - Session-Based Authentication, Forms validation
-- Deployment scripts: Heroku, Docker, Gunicorn / Nginx
-- UI Kit: **StarAdmin Dashboard** (PRO version) provided by **BootstrapDash**
-- License: [Commercial](https://github.com/app-generator/django-dashboard-staradmin-pro/blob/master/LICENSE.md)
-- LIVE 24/7 Support via [Discord](https://discord.gg/fZC6hup) and email **< support @ appseed.us >**
+- Deployment scripts: Docker, Gunicorn / Nginx
+- **Commercial License**: [Personal](https://github.com/app-generator/license-personal) / [Developer](https://github.com/app-generator/license-developer)
+- 24/7 Live Support via [Discord](https://discord.gg/fZC6hup).
 
-<br />
-
-## Dashboard Links
+> Links
 
-- [Django Dashboard StarAdmin PRO](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro) - Product page
-- [Django Dashboard StarAdmin PRO](https://django-dashboard-staradmin-pro.appseed.us/) - LIVE demo
+- [Django StarAdmin PRO](https://django-dashboard-staradmin-pro.appseed.us/) - LIVE Demo
+- [Django StarAdmin PRO](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro) - Official product page
+- More [Django Admin Dashboards](https://appseed.us/admin-dashboards/django) - index hosted by **[AppSeed](https://appseed.us)**
+- [Open-Source Admin Dashboards](https://appseed.us/admin-dashboards/open-source) - index hosted by **[AppSeed](https://appseed.us)**
 
 <br />
 
-![Django Dashboard StarAdmin PRO - Admin Panel coded in Django.](https://raw.githubusercontent.com/app-generator/django-dashboard-staradmin-pro/master/media/django-dashboard-staradmin-pro-intro.gif)
+![Django StarAdmin PRO - Admin Dashboard coded in Django.](https://raw.githubusercontent.com/app-generator/django-dashboard-staradmin-pro/master/media/django-dashboard-staradmin-pro-screen.png)
 
 <br />
 
-## Get the source code
-
-- Access the [product page](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro) and purchase a **license**
-- Connect with the support team via [Discord](https://discord.gg/fZC6hup) and email **< support @ appseed.us >**
-- Accept the invitation to the private repository (sent by the [AppSeed](http://appseed.us/) platform, once the purchase is validated)
-- Clone the source code and build the [Django Dashboard StarAdmin PRO](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro) using the instructions presented in this documentation.
-
-<br />
-
-## Prepare your environment
-
-The product is built on top of [Django](https://www.djangoproject.com/), a popular Python Web Framework. To build the app, Python3 should be installed properly in the workstation. If you are not sure if Python is properly installed, please open a terminal and type `python --version`. The full-list with dependencies and tools required to build the app:
-
-- [Python3](https://www.python.org/) - the programming language used to code the app
-- [Git](https://git-scm.com/) - used to clone the source code from the Github repository
-- A [Github](https://github.com/) account - the invitation to the source code, will be sent on your account.
-- Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
-
-<br />
-
-> Check Python (using the terminal)
-
-```bash
-$ # Check Python version
-$ python --version
-Python 3.7 # <--- All good
-```
-
-<br />
-
-> Check GIT command tool (using the terminal)
-
-```bash
-$ # Check git
-$ git --version
-$ git version 2.10 # <--- All good
-```
-
-<br />
-
-For more information on how to set up your environment please access the resources listed below. In case we've missed something, contact us on Discord.
-
-- [How to set up Python](https://docs.appseed.us/how-to/install-python)
-- [Setup CentOS for development](https://docs.appseed.us/how-to/setup-centos-for-development/)
-- [Setup Ubuntu for development](https://docs.appseed.us/how-to/setup-ubuntu-for-development/)
-- [Setup Windows for development](https://docs.appseed.us/how-to/setup-windows-for-development/)
-
-<br />
-
-## Project Structure
-
-The boilerplate code is built with a modular structure that follows the recommended pattern used by many open-source projects. The most important files and  directories are shown below:
-
-<br />
-
-```bash
-< PROJECT ROOT >                               # application root folder
-    |
-    |--- core/__init__.py                      # Handles the core features
-    |--- core/                                 # define app settings and serve statis assets and pages
-    |      | --- <templates>
-    |      |        |---<includes>             # Page chunks, components
-    |      |        |---<layouts>              # App Layouts (the master pages)
-    |      |        |---<account>              # Auth Pages (login, register)
-    |      |        |---<pages>                # App Pages
-    |      |
-    |      | --- views.py
-    |      | --- urls.py
-    |      | --- models.py
-    |
-    |--- app/__init__.py                       # Django app that serve the pages
-    |--- app/                                  # for authenticated users
-    |      | --- views.py
-    |      | --- urls.py
-    |      | --- models.py
-    |
-    |--- authentication/__init__.py            # Django app that serve the pages
-    |--- authentication/                       # for authenticated users
-    |      | --- forms.py                      # Login, Register forms
-    |      | --- views.py
-    |      | --- urls.py
-    |      | --- models.py
-    |
-    |--- requirements.txt                      # Requirements - SQLite storage
-    |
-    |--- manage.py                             # bootstrap the app
-    |
-    |-----------------------------
-```
-
-<br />
-
-## Build from sources
-
-> Note: this is a private repository. To get access, you should buy a license from the [product page](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro). 
-
-<br />
+## How to use it
 
 ```bash
 $ # Get the code
@@ -138,7 +38,7 @@ $ # Virtualenv modules installation (Windows based systems)
 $ # virtualenv env
 $ # .\env\Scripts\activate
 $
-$ # Install modules - SQLite Database
+$ # Install modules - SQLite Storage
 $ pip3 install -r requirements.txt
 $
 $ # Create tables
@@ -148,12 +48,80 @@ $
 $ # Start the application (development mode)
 $ python manage.py runserver # default port 8000
 $
-$ # Start the app - custom port 
+$ # Start the app - custom port
 $ # python manage.py runserver 0.0.0.0:<your_port>
 $
 $ # Access the web app in browser: http://127.0.0.1:8000/
 ```
 
+> Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages.
+
+<br />
+
+## Code-base structure
+
+The project is coded using a simple and intuitive structure presented bellow:
+
+```bash
+< PROJECT ROOT >
+   |
+   |-- core/                               # Implements app logic and serve the static assets
+   |    |-- settings.py                    # Django app bootstrapper
+   |    |-- wsgi.py                        # Start the app in production
+   |    |-- urls.py                        # Define URLs served by all apps/nodes
+   |    |
+   |    |-- static/
+   |    |    |-- <css, JS, images>         # CSS files, Javascripts files
+   |    |
+   |    |-- templates/                     # Templates used to render pages
+   |         |
+   |         |-- includes/                 # HTML chunks and components
+   |         |    |-- navigation.html      # Top menu component
+   |         |    |-- sidebar.html         # Sidebar component
+   |         |    |-- footer.html          # App Footer
+   |         |    |-- scripts.html         # Scripts common to all pages
+   |         |
+   |         |-- layouts/                  # Master pages
+   |         |    |-- base-fullscreen.html # Used by Authentication pages
+   |         |    |-- base.html            # Used by common pages
+   |         |
+   |         |-- accounts/                 # Authentication pages
+   |         |    |-- login.html           # Login page
+   |         |    |-- register.html        # Register page
+   |         |
+   |      index.html                       # The default page
+   |     page-404.html                     # Error 404 page
+   |     page-500.html                     # Error 404 page
+   |       *.html                          # All other HTML pages
+   |
+   |-- authentication/                     # Handles auth routes (login and register)
+   |    |
+   |    |-- 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  
+   |
+   |-- requirements.txt                    # Development modules - SQLite storage
+   |
+   |-- .env                                # Inject Configuration via Environment
+   |-- manage.py                           # Start the app - Django default start script
+   |
+   |-- ************************************************************************
+```
+
+<br />
+
+> The bootstrap flow
+
+- Django bootstrapper `manage.py` uses `core/settings.py` as the main configuration file
+- `core/settings.py` loads the app magic from `.env` file
+- Redirect the guest users to Login page
+- Unlock the pages served by *app* node for authenticated users
+
 <br />
 
 ## Deployment
@@ -178,7 +146,7 @@ $ cd priv-django-dashboard-staradmin-pro
 $ 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:5005` in your browser. The app should be up & running.
 
 <br />
 
@@ -225,50 +193,13 @@ Visit `http://localhost:8001` in your browser. The app should be up & running.
 
 <br />
 
-## Django StarAdmin PRO - app screens
-
-<br />
-
-![Django Dashboard StarAdmin PRO - Main Screen.](https://raw.githubusercontent.com/app-generator/django-dashboard-staradmin-pro/master/media/django-dashboard-staradmin-pro-screen.png)
-
-<br />
-
-![Django Dashboard StarAdmin PRO - Widgets Screen.](https://raw.githubusercontent.com/app-generator/django-dashboard-staradmin-pro/master/media/django-dashboard-staradmin-pro-screen-1.png)
-
-<br />
-
-![Django Dashboard StarAdmin PRO - Image Gallery.](https://raw.githubusercontent.com/app-generator/django-dashboard-staradmin-pro/master/media/django-dashboard-staradmin-pro-screen-4.png)
-
-<br />
-
 ## Credits & Links
 
-<br />
-
-### [Django Admin Dashboards PRO](https://appseed.us/admin-dashboards/django)
-
-Index with **Premium UI-ready admin dashboards** generated by the AppSeed platform in [Django Framework](https://www.djangoproject.com/).
-Start fast your next Django project by using functional admin dashboards enhanced with Database, ORM, authentication flow, helpers and deployment scripts.
-
-<br />
-
-### What is [Django](https://www.palletsprojects.com/p/flask/)
-
-[Django](https://www.palletsprojects.com/p/flask/) is a lightweight WSGI web application framework. It is designed to make getting started quick and easy, with the ability to scale up to complex applications. It began as a simple wrapper around Werkzeug and Jinja and has become one of the most popular Python web application frameworks.
-
-<br />
-
-### [What is a dashboard](https://en.wikipedia.org/wiki/Dashboard_(business))
-
-A dashboard is a set of pages that are easy to read and offer information to the user in real-time regarding his business. A dashboard usually consists of graphical representations of the current status and trends within an organization. Having a well-designed dashboard will give you the possibility to act and make informed decisions based on the data that your business provides - *definition provided by [Creative-Tim - Free Dashboard Templates](https://www.creative-tim.com/blog/web-design/free-dashboard-templates/?ref=appseed)*.
-
-<br />
-
-### [StarAdmin Dashboard PRO](https://www.bootstrapdash.com/product/star-admin-pro/)
-
-Designed based on the Bootstrap framework, Star Admin Pro is a powerful, feature-rich, and super flexible admin dashboard template. It serves as the perfect starting point for both simple and complex web development projects. It features a well-designed dashboard with several neatly arranged components and essential elements.
+- [Django](https://www.djangoproject.com/) - The official website
+- [Django Admin Dashboards](https://appseed.us/admin-dashboards/django) - Index provided by **AppSeed**
+- [Django Admin Dashboards](https://github.com/app-generator/django-admin-dashboards) - Index published on Github
 
 <br />
 
 ---
-[Django Dashboard StarAdmin PRO](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro) - Provided by **AppSeed** [Web App Generator](https://appseed.us/app-generator).
+[Django StarAdmin PRO](https://appseed.us/admin-dashboards/django-dashboard-staradmin-pro) - Provided by **AppSeed** [Web App Generator](https://appseed.us/app-generator).