From ebea8dde179c71d9ce15ba1570a114bccdbdd158 Mon Sep 17 00:00:00 2001 From: App Generator <51070104+app-generator@users.noreply.github.com> Date: Sat, 10 Feb 2024 16:33:29 +0200 Subject: [PATCH] Release v1.0.15 --- CHANGELOG.md | 123 ++++++++++++++++++++++++++++ LICENSE.md | 75 +++++++++++++++++ README.md | 224 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 422 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..76f0d50 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,123 @@ +# Change Log + +## [1.0.15] 2024-02-10 +### Changes + +- Update DOCS (readme) + +## [1.0.14] 2024-02-10 +### Changes + +- Update README (docs) +- Update Docker +- New Apps: + - charts + - api + - celery + - file manager + - dark mode + - i18n (internationalization) + +## [1.0.13] 2023-08-14 +### Changes + +- Fix #29, collectstatic bumps errors +- Remove `ASSETS_ROOT` variable +- Added `Render` Support (CI/CD) + +## [1.0.12] 2023-04-08 +### Changes + +- Fix #27: Added Export Options for Datatables + - `CSV`, `XLS` + +## [1.0.11] 2022-08-20 +### Improvements + +- Added notifications in `user-profile` page + - Update profile + - change password + +## [1.0.10] 2022-08-20 +### Fixes & Improvements + +- Improved Authentication Flow +- Docker Scripts Update +- CleanUp (migration files removed) +- Minor JS Fixes + +## [1.0.9] 2022-08-16 +### Fixes & Minor Improvements + +- Improved Authentication Flow +- Minor JS Fixes + +## [1.0.8] 2022-08-08 +### Improvements + +- **Social Login** via `Github` & `Twitter` +- `Change password`, `Self Deletion` +- `Authentication` via email OR username + +## [1.0.7] 2022-07-15 +### Evolutions + +- User Settings + - Self deletion + - Update Password + +## [1.0.6] 2022-07-14 +### Fixes + +- Patch Docker set up + - now supports the latest evolutions + +## [1.0.5] 2022-07-14 +### Improvements + +- Improved Authentication + - Visual password strength indicator (registration) + - Suspend user after 3 failed login attempts +- New Feature: `User Profiles` + - Extended User profile + - Image upload via `FTP` + +## [1.0.4] 2022-06-28 +### Improvements + +- Bump UI to `Soft UI Dashboard PRO v1.0.8` +- Improved `Docker` +- Improved Codebase + +## [1.0.3] 2021-12-14 +### Improvements + +- Bump UI: Soft UI Dashboard PRO v1.0.5 + +## [1.0.2] 2021-09-20 +### Improvements + +- Bump Django Codebase to [v2.0.4](https://github.com/app-generator/boilerplate-code-django-dashboard/releases) +- Codebase update + - `assets` & `templates` moved to `apps` folder + - `apps/base` renamed to `apps/home` + +## [1.0.1] 2021-09-08 +### 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 +- 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.0] 2021-06-25 +### Initial release + +- UI: Soft UI Dashboard PRO v1.0.1 +- [Django Codebase](https://github.com/app-generator/boilerplate-code-django-dashboard): v1.0.4 diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..87caf48 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,75 @@ +# Commercial Projects - EULA + +Copyright (c) 2019 - present [AppSeed](http://appseed.us/) + +
+ +## Licensing Information + +This document explains the usage terms for all **commercial** products (apps/tools) developed by **[AppSeed](http://appseed.us/)**. + +Used terms: + +- `Solo-Developer`: code digital products as freelencer (without being incorporated in a company) +- `StartUp` - young company founded 12mo (or less) in the past +- `Small Company` - maximum 3 developers, active for more than 1year +- `Company` - More than 4 developers and less than 50 +- `Corporate` - More than 50 developers + +
+ +## [Personal License](https://github.com/app-generator/license-personal) + +> Licensing Information - full info [here](https://github.com/app-generator/license-personal) + +| Item | - | +| ---------------------------------- | --- | +| Domains | 1 | +| Team Size | **3 developer** | +| [Support](https://appseed.us/support/) & Updates: | **6 months** | +| --- | --- | +| Product sale | ✅ | +| Create single personal website/app | ✅ | +| Create single website/app for client | ✅ | +| Remove footer credits | ✅ | +| SaaS application | ❌ | + +
+ +## [StartUp License](https://github.com/app-generator/license-startup) + +> Licensing Information - full info [here](https://github.com/app-generator/license-startup) + +| Item | - | +| ---------------------------------- | --- | +| Domains | 1 | +| Team Size | **Up to 9 developers** | +| [Support](https://appseed.us/support/) & Updates: | **12 months** | +| --- | --- | +| Product sale | ✅ | +| Create single personal website/app | ✅ | +| Create single website/app for client | ✅ | +| Remove footer credits | ✅ | +| SaaS application | ❌ | + +
+ +## [Company License](https://github.com/app-generator/license-company) + +> Licensing Information - full info [here](https://github.com/app-generator/license-company) + +| Item | - | +| ---------------------------------- | --- | +| Team Size | **Unlimited** | +| [Support](https://appseed.us/support/) & Updates: | **Lifetime** | +| --- | --- | +| Product sale | ✅ | +| Create multiple personal websites/apps | ✅ | +| Create multiple websites/apps for clients | ✅ | +| Remove footer credits | ✅ | +| SaaS application | ✅ | + +
+ +--- +For more information regarding licensing, please contact the [AppSeed](https://appseed.us/) Service < *support@appseed.us* > diff --git a/README.md b/README.md new file mode 100644 index 0000000..4bbc98b --- /dev/null +++ b/README.md @@ -0,0 +1,224 @@ +# [Soft Dashboard PRO Django](https://appseed.us/product/soft-ui-dashboard-pro/django/) + +**Django** starter styled with **[Soft Dashboard PRO](https://appseed.us/product/soft-ui-dashboard-pro/django/)**, a premium `Bootstrap 5` KIT from `Creative-Tim`. +The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. + +- 👉 [Soft UI Dashboard PRO Django](https://appseed.us/product/soft-ui-dashboard-pro/django/) - `Product Page` +- 👉 [Soft UI Dashboard PRO Django](https://django-soft-dash-pro.onrender.com/) - `LIVE Demo` + +
+ +## Features + +- `Up-to-date dependencies` +- Database: `SQLite`, PgSQL, MySql +- **Authentication** + - `Session-Based authentication` + - `Social Login`: **Github** & **Google** +- **User Extended profile** +- **API** via DRF +- DataTables +- Charts +- Celery +- File Manager +- i18n (internationalization) +- `Docker` + +![Soft Dashboard PRO Django](https://github.com/app-generator/priv-django-soft-ui-dashboard-enh/assets/51070104/108fab39-b351-41c9-b9b0-06e8fdde51f9) + +
+ +## Start in `Docker` + +> **Step 1** - Download the [code](https://appseed.us/product/soft-ui-dashboard-pro/django/) and unzip the sources (requires a `purchase`). + +```bash +$ unzip django-soft-ui-dashboard-pro.zip +$ cd django-soft-ui-dashboard-pro +``` + +
+ +> **Step 2** - Start the APP in `Docker` + +```bash +# Optional (kill all existing containers) +$ docker container kill $(docker ps -q) ; docker container rm $(docker ps -a -q) ; docker network prune -f +# Start the APP +$ docker-compose up --build +``` + +Visit `http://localhost:5085` in your browser. The app should be up & running. + +
+ +## Create new `.env` from `env.sample` + +The meaning of each variable can be found below: + +- `DEBUG`: if `True` the app runs in develoment mode + - For production value `False` should be used +- `MYSQL` credentials + - `DB_ENGINE`, default value = `mysql` + - `DB_NAME`, default value = `appseed_db` + - `DB_HOST`, default value = `localhost` + - `DB_PORT`, default value = `3306` + - `DB_USERNAME`, default value = `appseed_db_usr` + - `DB_PASS`, default value = `pass` +- `OAuth` via Github + - `GITHUB_ID`= + - `GITHUB_SECRET`= +- `OAuth` via Google + - `GOOGLE_CLIENT_ID`= + - `GOOGLE_SECRET_KEY`= + +
+ +## Manual Build + +> Download the [code](https://appseed.us/product/soft-ui-dashboard-pro/django/) and unzip the sources (requires a `purchase`). + +```bash +$ unzip django-soft-ui-dashboard-pro.zip +$ cd django-soft-ui-dashboard-pro +``` + +
+ +### 👉 Set Up for `Unix`, `MacOS` + +> Install modules via `VENV` + +```bash +$ virtualenv env +$ source env/bin/activate +$ pip3 install -r requirements.txt +``` + +
+ +> Set Up Database + +```bash +$ python manage.py makemigrations +$ python manage.py migrate +``` + +
+ +> Create Superuser + +```bash +$ python manage.py createsuperuser +``` + +
+ +> Start the app + +```bash +$ python manage.py runserver +``` + +At this point, the app runs at `http://127.0.0.1:8000/`. + +
+ +### 👉 Set Up for `Windows` + +> Install modules via `VENV` (windows) + +``` +$ virtualenv env +$ .\env\Scripts\activate +$ pip3 install -r requirements.txt +``` + +
+ +> Set Up Database + +```bash +$ python manage.py makemigrations +$ python manage.py migrate +``` + +
+ +> Start the app + +```bash +$ python manage.py runserver +``` + +At this point, the app runs at `http://127.0.0.1:8000/`. + +
+ +### 👉 Create Users + +By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: + +- Start the app +- Access the `registration` page and create a new user: + - `http://127.0.0.1:8000/register/` +- Access the `sign in` page and authenticate + - `http://127.0.0.1:8000/login/` + +
+ +## Enable Social Login + +> 👉 **Github Setup** - [Create an OAuth App](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) + +- SignIN to `Github` +- Access `Settings` -> `Developer Settings` -> `OAuth Apps` +- Edit your OAuth App + - `App Name` + - `App Description` + - (mandatory) `HomePage`: `https://localhost:8000` + - (mandatory) `Authorization callback URL`: `https://localhost:8000/` + - Generate a new `secret key` + +
+ +## Codebase + +The project is coded using a simple and intuitive structure presented below: + +```bash +< PROJECT ROOT > + | + |-- core/ # Implements app configuration + | |-- settings.py # Defines Global Settings + | |-- wsgi.py # Start the app in production + | |-- urls.py # Define URLs served by all apps/nodes + | + |-- home/ # Serves all pages from the UI Kit + | + |-- apps/ + | | + | |-- common/ # Assets used by all APPS (models, helpers) + | |-- users/ # Handles Auth Flow + | |-- api/ # DRF API + | |-- charts/ # Charts APP + | |-- tables/ # DataTables APP + | |-- tasks/ # Celery App + | + |-- templates/ # Pages & Templates + |-- assets/ # Static Assets [ JS, CSS, images ] + | + |-- requirements.txt # Development modules - SQLite storage + | + |-- .env # Environment + |-- env.sample # Environment Sample + | + |-- manage.py # Django Manager File + | + |-- ************************************************************************ +``` + +
+ +--- +[Soft Dashboard PRO Django](https://appseed.us/product/soft-ui-dashboard-pro/django/) - Starter crafted by **[AppSeed](https://appseed.us/)**.