Skip to content

Commit c196baf

Browse files
app-generatorapp-generator
committed
Release v1.0.3
1 parent dd35d98 commit c196baf

File tree

3 files changed

+331
-0
lines changed

3 files changed

+331
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Change Log
2+
3+
## [1.0.3] 2024-02-18
4+
### Changes
5+
6+
- Update README (docs)
7+
- Update Docker
8+
- New Apps:
9+
- charts
10+
- api
11+
- celery
12+
- file manager
13+
- dark mode
14+
- i18n (internationalization)
15+
16+
## [1.0.2] 2023-05-22
17+
### Changes
18+
19+
- Update Links (added product page)
20+
- [Django Modernize PRO](https://appseed.us/product/modernize-dashboard-pro/django/)
21+
- [Django Modernize](https://appseed.us/product/modernize-dashboard/django/)
22+
23+
## [1.0.1] 2023-05-20
24+
### Changes
25+
26+
- Update README, added links
27+
- 👉 [LIVE DEMO](https://django-modernize-pro.onrender.com)
28+
- 🛒 [Payment Link](https://appseed.gumroad.com/l/django-modernize-pro) via `GUMROAD`
29+
30+
## [1.0.0] 2023-05-10
31+
### Changes
32+
33+
- STABLE Version

‎LICENSE.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Commercial Projects - EULA
2+
3+
Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
4+
5+
<br />
6+
7+
## Licensing Information
8+
9+
This document explains the usage terms for all **commercial** products (apps/tools) developed by **[AppSeed](http://appseed.us/)**.
10+
11+
Used terms:
12+
13+
- `Solo-Developer`: code digital products as freelencer (without being incorporated in a company)
14+
- `StartUp` - young company founded 12mo (or less) in the past
15+
- `Small Company` - maximum 3 developers, active for more than 1year
16+
- `Company` - More than 4 developers and less than 50
17+
- `Corporate` - More than 50 developers
18+
19+
<br />
20+
21+
## [Personal License](https://github.com/app-generator/license-personal)
22+
23+
> Licensing Information - full info [here](https://github.com/app-generator/license-personal)
24+
25+
| Item | - |
26+
| ---------------------------------- | --- |
27+
| Domains | 1 |
28+
| Team Size | **3 developer** |
29+
| [Support](https://appseed.us/support/) & Updates: | **6 months** |
30+
| --- | --- |
31+
| Product sale | ✅ |
32+
| Create single personal website/app | ✅ |
33+
| Create single website/app for client | ✅ |
34+
| Remove footer credits | ✅ |
35+
| SaaS application | ❌ |
36+
37+
<br />
38+
39+
## [StartUp License](https://github.com/app-generator/license-startup)
40+
41+
> Licensing Information - full info [here](https://github.com/app-generator/license-startup)
42+
43+
| Item | - |
44+
| ---------------------------------- | --- |
45+
| Domains | 1 |
46+
| Team Size | **Up to 9 developers** |
47+
| [Support](https://appseed.us/support/) & Updates: | **12 months** |
48+
| --- | --- |
49+
| Product sale | ✅ |
50+
| Create single personal website/app | ✅ |
51+
| Create single website/app for client | ✅ |
52+
| Remove footer credits | ✅ |
53+
| SaaS application | ❌ |
54+
55+
<br />
56+
57+
## [Company License](https://github.com/app-generator/license-company)
58+
59+
> Licensing Information - full info [here](https://github.com/app-generator/license-company)
60+
61+
| Item | - |
62+
| ---------------------------------- | --- |
63+
| Team Size | **Unlimited** |
64+
| [Support](https://appseed.us/support/) & Updates: | **Lifetime** |
65+
| --- | --- |
66+
| Product sale | ✅ |
67+
| Create multiple personal websites/apps | ✅ |
68+
| Create multiple websites/apps for clients | ✅ |
69+
| Remove footer credits | ✅ |
70+
| SaaS application | ✅ |
71+
72+
<br />
73+
74+
---
75+
For more information regarding licensing, please contact the [AppSeed](https://appseed.us/) Service < *support@appseed.us* >

‎README.md‎

Lines changed: 223 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
# [Django Modernize PRO](https://appseed.us/product/modernize-dashboard-pro/django/)
2+
3+
**Django Dashboard** crafted by `AppSeed` on top of a modern design. **[Modernize PRO](https://appseed.us/product/modernize-dashboard-pro/django/)** is a premium `Bootstrap 5` designed by `AdminMart` that comes with feature-rich pages and developer-centric code components. This design provides many prebuilt admin layouts which give you the best selection choice for a modern dashboard.
4+
5+
- 👉 [Modernize PRO Django](https://appseed.us/product/datta-able-pro/django/) - `product page`
6+
- 👉 [Modernize PRO Django](https://django-modernize-pro.onrender.com) - `LIVE Demo`
7+
8+
<br />
9+
10+
## Features
11+
12+
- `Up-to-date dependencies`
13+
- Database: `SQLite`, PgSQL, MySql
14+
- **Authentication**
15+
- `Session-Based authentication`
16+
- `Social Login`: **Github** & **Google**
17+
- **User Extended profile**
18+
- **API** via DRF
19+
- DataTables
20+
- Charts
21+
- Celery
22+
- File Manager
23+
- i18n (internationalization)
24+
- `Docker`
25+
26+
![Modernize PRO - Thumb Image](https://github.com/app-generator/dummy/assets/51070104/6b1d21c2-5e26-4708-bcc5-7958e7f49d3d)
27+
28+
<br />
29+
30+
## Start in `Docker`
31+
32+
> **Step 1** - Download the [code](https://appseed.us/product/modernize-dashboard-pro/django/) and unzip the sources (requires a `purchase`).
33+
34+
```bash
35+
$ unzip django-modernize-pro.zip
36+
$ cd django-modernize-pro
37+
```
38+
39+
<br />
40+
41+
> **Step 2** - Start the APP in `Docker`
42+
43+
```bash
44+
# Optional (kill all existing containers)
45+
$ docker container kill $(docker ps -q) ; docker container rm $(docker ps -a -q) ; docker network prune -f
46+
# Start the APP
47+
$ docker-compose up --build
48+
```
49+
50+
Visit `http://localhost:5085` in your browser. The app should be up & running.
51+
52+
<br />
53+
54+
## Create new `.env` from `env.sample`
55+
56+
The meaning of each variable can be found below:
57+
58+
- `DEBUG`: if `True` the app runs in develoment mode
59+
- For production value `False` should be used
60+
- `MYSQL` credentials
61+
- `DB_ENGINE`, default value = `mysql`
62+
- `DB_NAME`, default value = `appseed_db`
63+
- `DB_HOST`, default value = `localhost`
64+
- `DB_PORT`, default value = `3306`
65+
- `DB_USERNAME`, default value = `appseed_db_usr`
66+
- `DB_PASS`, default value = `pass`
67+
- `OAuth` via Github
68+
- `GITHUB_ID`=<GITHUB_ID_HERE>
69+
- `GITHUB_SECRET`=<GITHUB_SECRET_HERE>
70+
- `OAuth` via Google
71+
- `GOOGLE_CLIENT_ID`=<GOOGLE_ID_HERE>
72+
- `GOOGLE_SECRET_KEY`=<GOOGLE_SECRET_HERE>
73+
74+
<br />
75+
76+
## Manual Build
77+
78+
> **Step 1** - Download the [code](https://appseed.us/product/modernize-dashboard-pro/django/) and unzip the sources (requires a `purchase`).
79+
80+
```bash
81+
$ unzip django-modernize-pro.zip
82+
$ cd django-modernize-pro
83+
```
84+
85+
<br />
86+
87+
### 👉 Set Up for `Unix`, `MacOS`
88+
89+
> Install modules via `VENV`
90+
91+
```bash
92+
$ virtualenv env
93+
$ source env/bin/activate
94+
$ pip3 install -r requirements.txt
95+
```
96+
97+
<br />
98+
99+
> Set Up Database
100+
101+
```bash
102+
$ python manage.py makemigrations
103+
$ python manage.py migrate
104+
```
105+
106+
<br />
107+
108+
> Create Superuser
109+
110+
```bash
111+
$ python manage.py createsuperuser
112+
```
113+
114+
<br />
115+
116+
> Start the app
117+
118+
```bash
119+
$ python manage.py runserver
120+
```
121+
122+
At this point, the app runs at `http://127.0.0.1:8000/`.
123+
124+
<br />
125+
126+
### 👉 Set Up for `Windows`
127+
128+
> Install modules via `VENV` (windows)
129+
130+
```
131+
$ virtualenv env
132+
$ .\env\Scripts\activate
133+
$ pip3 install -r requirements.txt
134+
```
135+
136+
<br />
137+
138+
> Set Up Database
139+
140+
```bash
141+
$ python manage.py makemigrations
142+
$ python manage.py migrate
143+
```
144+
145+
<br />
146+
147+
> Start the app
148+
149+
```bash
150+
$ python manage.py runserver
151+
```
152+
153+
At this point, the app runs at `http://127.0.0.1:8000/`.
154+
155+
<br />
156+
157+
### 👉 Create Users
158+
159+
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
160+
161+
- Start the app
162+
- Access the `registration` page and create a new user:
163+
- `http://127.0.0.1:8000/register/`
164+
- Access the `sign in` page and authenticate
165+
- `http://127.0.0.1:8000/login/`
166+
167+
<br />
168+
169+
## Enable Social Login
170+
171+
> 👉 **Github Setup** - [Create an OAuth App](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app)
172+
173+
- SignIN to `Github`
174+
- Access `Settings` -> `Developer Settings` -> `OAuth Apps`
175+
- Edit your OAuth App
176+
- `App Name`
177+
- `App Description`
178+
- (mandatory) `HomePage`: `https://localhost:8000`
179+
- (mandatory) `Authorization callback URL`: `https://localhost:8000/`
180+
- Generate a new `secret key`
181+
182+
<br />
183+
184+
## Codebase
185+
186+
The project is coded using a simple and intuitive structure presented below:
187+
188+
```bash
189+
< PROJECT ROOT >
190+
|
191+
|-- core/ # Implements app configuration
192+
| |-- settings.py # Defines Global Settings
193+
| |-- wsgi.py # Start the app in production
194+
| |-- urls.py # Define URLs served by all apps/nodes
195+
|
196+
|-- home/ # Serves all pages from the UI Kit
197+
|
198+
|-- apps/
199+
| |
200+
| |-- common/ # Assets used by all APPS (models, helpers)
201+
| |-- users/ # Handles Auth Flow
202+
| |-- api/ # DRF API
203+
| |-- charts/ # Charts APP
204+
| |-- tables/ # DataTables APP
205+
| |-- tasks/ # Celery App
206+
|
207+
|-- templates/ # Pages & Templates
208+
|-- assets/ # Static Assets [ JS, CSS, images ]
209+
|
210+
|-- requirements.txt # Development modules - SQLite storage
211+
|
212+
|-- .env # Environment
213+
|-- env.sample # Environment Sample
214+
|
215+
|-- manage.py # Django Manager File
216+
|
217+
|-- ************************************************************************
218+
```
219+
220+
<br />
221+
222+
---
223+
[Django Modernize PRO](https://appseed.us/product/modernize-dashboard-pro/django/) - Starter crafted by **[AppSeed](https://appseed.us/)**.

0 commit comments

Comments
 (0)