Skip to content

Commit 6695bd7

Browse files
app-generatorapp-generator
committed
Release v1.0.5
1 parent b0598d3 commit 6695bd7

File tree

3 files changed

+354
-0
lines changed

3 files changed

+354
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Change Log
2+
3+
## [1.0.5] 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.4] 2023-01-31
17+
### Changes
18+
19+
- DOCS Update (readme). New sections:
20+
- `How to customize the theme`
21+
- Render deployment
22+
- Configure the project to use `home/templates`
23+
- Added `custom-footer` sample
24+
25+
## [1.0.3] 2023-01-03
26+
### Changes
27+
28+
- DOCS Update (readme)
29+
- Publish product on AppSeed:
30+
- [Django Berry PRO](https://appseed.us/product/berry-dashboard-pro/django/) - `fully configured`
31+
32+
## [1.0.2] 2023-01-03
33+
### Changes
34+
35+
- DOCS Update (readme)
36+
37+
## [1.0.1] 2022-12-21
38+
### Changes
39+
40+
- DOCS Update
41+
- Fix Render Deployment
42+
43+
## [1.0.0] 2022-12-20
44+
### Changes
45+
46+
- Deployment-ready for Render
47+
- `render.yaml`
48+
- Tested for [Django Berry PRO](https://github.com/app-generator/django-admin-berry-pro) `v1.0.0`
49+
50+
## [0.0.1] 2022-11-17
51+
### Initial Release
52+
53+
- Integrate [Django Berry PRO](https://github.com/app-generator/django-admin-berry-pro)

‎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 < *[email protected]* >

‎README.md‎

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

0 commit comments

Comments
 (0)