Release v1.0.2

app-generator · Mar 5, 2024 · 09f65f5 · 09f65f5
1 parent 92be780
commit 09f65f5
Show file tree

Hide file tree

Showing 3 changed files with 346 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,30 @@
+# Change Log
+
+## [1.0.2] 2024-03-05
+### Changes
+
+- Update README (docs)
+- Update Docker
+- New Apps:
+  - charts
+  - api
+  - celery
+  - file manager
+  - dark mode 
+  - i18n (internationalization) 
+
+## [1.0.1] 2023-02-13
+### Changes
+
+- DOCS Update (readme). New sections:
+  - `How to customize the theme`
+  - Render deployment
+- Configure the project to use `home/templates`
+- Added `custom-footer` sample
+
+## [1.0.0] 2023-01-25
+### Changes
+
+- Stable Version
+- Integrate [Django Argon PRO](https://github.com/app-generator/django-admin-argon-pro)
+- CI/CD included via `Render`
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,75 @@
+# Commercial Projects - EULA 
+
+Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
+
+<br />
+
+## 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 
+
+<br />
+
+## [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 | ❌ |
+
+<br />
+
+## [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 | ❌ |
+
+<br />
+
+## [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 | ✅ |
+
+<br />
+
+---
+For more information regarding licensing, please contact the [AppSeed](https://appseed.us/) Service < *support@appseed.us* >
diff --git a/README.md b/README.md
@@ -0,0 +1,241 @@
+# [Django Argon PRO](https://appseed.us/product/argon-dashboard-pro/django/)
+
+**Django** starter styled with **[Argon Dashboard PRO](https://appseed.us/product/argon-dashboard-pro/django/)**, a premium `Bootstrap` Design from [Creative-Tim](https://bit.ly/3fKQZaL).
+The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. 
+
+- 🛒 [Django Argon PRO](https://appseed.us/product/argon-dashboard-pro/django/) - `Product page` (contains payment links)
+- 👉 [Django Argon PRO](https://django-argon-dash-pro.onrender.com) - `LIVE Demo`
+
+<br />
+
+## 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`
+
+![Django Argon PRO - Premium Seed project powered by Flask.](https://user-images.githubusercontent.com/51070104/213974264-fe9250ff-7035-427b-b63f-bf69790f5a73.png)
+
+<br />
+
+## Start in `Docker`
+
+> **Step 1** - Download the [code](https://appseed.us/product/argon-dashboard-pro/django/) and unzip the sources (requires a `purchase`). 
+
+```bash
+$ unzip django-argon-dashboard-pro.zip
+$ cd django-argon-dashboard-pro
+```
+
+<br />
+
+> **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.
+
+<br />
+
+## 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_ID_HERE>
+  - `GITHUB_SECRET`=<GITHUB_SECRET_HERE> 
+- `OAuth` via Google
+  - `GOOGLE_CLIENT_ID`=<GOOGLE_ID_HERE>
+  - `GOOGLE_SECRET_KEY`=<GOOGLE_SECRET_HERE> 
+
+<br />
+
+## Manual Build
+
+> - Download the [code](https://appseed.us/product/argon-dashboard-pro/django/) and unzip the sources (requires a `purchase`). 
+
+```bash
+$ unzip django-argon-dashboard-pro.zip
+$ cd django-argon-dashboard-pro
+```
+
+<br />
+
+### 👉 Set Up for `Unix`, `MacOS` 
+
+> Install modules via `VENV`  
+
+```bash
+$ virtualenv env
+$ source env/bin/activate
+$ pip3 install -r requirements.txt
+```
+
+<br />
+
+> Set Up Database
+
+```bash
+$ python manage.py makemigrations
+$ python manage.py migrate
+```
+
+<br />
+
+> Create 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 />
+
+### 👉 Set Up for `Windows` 
+
+> Install modules via `VENV` (windows) 
+
+```
+$ virtualenv env
+$ .\env\Scripts\activate
+$ pip3 install -r requirements.txt
+```
+
+<br />
+
+> Set Up Database
+
+```bash
+$ python manage.py makemigrations
+$ python manage.py migrate
+```
+
+<br />
+
+> Start the app
+
+```bash
+$ python manage.py runserver
+```
+
+At this point, the app runs at `http://127.0.0.1:8000/`. 
+
+<br />
+
+### 👉 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/`
+
+<br />
+
+## Start Celery (async task)
+
+- Make sure you have a Redis Server running: `redis://localhost:6379`
+  - `$ redis-cli` and type `ping` 
+- In the base directory inside `tasks_scripts` folder you need to write your scripts file.
+- Run the celery command from the CLI.
+
+```bash
+$ export DJANGO_SETTINGS_MODULE="core.settings"  
+$ celery -A apps.tasks worker -l info -B
+```
+
+- You will see a new route `Apps -> Tasks` in the sidebar.
+- You can start and cancel any task from the UI.
+
+<br />
+
+## 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`
+
+<br />
+
+## 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
+   |
+   |-- ************************************************************************
+```
+
+<br />
+
+---
+[Django Argon PRO](https://appseed.us/product/argon-dashboard-pro/django/) - Starter crafted by **[AppSeed](https://appseed.us/)**.