|
1 | 1 | # [Django Berry PRO](https://appseed.us/product/berry-dashboard-pro/django/) |
2 | 2 |
|
3 | | -**Django** starter styled with **[Berry Dashboard PRO](https://appseed.us/product/berry-dashboard-pro/django/)**, a premium `Bootstrap 5` design from `CodedThemes`. |
| 3 | +**Premium Django Starter** crafted on top of **[Berry PRO](https://app-generator.dev/product/berry-dashboard/)**, a premium `Bootstrap` UI Kit released by [CodedThemes](https://app-generator.dev/agency/codedthemes/). |
4 | 4 | The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. |
5 | 5 |
|
6 | 6 | - 🛒 [Django Berry PRO](https://appseed.us/product/berry-dashboard-pro/django/) - `Product page` (contains payment links) |
7 | | -- 👉 [Django Berry PRO](https://django-berry-pro.onrender.com) - `LIVE Demo` |
| 7 | +- 👉 [Django Berry PRO](https://django-berry-pro.onrender.com/dashboard/) - `LIVE Demo` |
| 8 | +- 👉 [Django Berry PRO](https://app-generator.dev/docs/products/django/berry-pro/index.html) - `Documentation` (learn how to use the product) |
8 | 9 |
|
9 | 10 | <br /> |
10 | 11 |
|
11 | 12 | ## Features |
12 | 13 |
|
13 | | -- `Up-to-date dependencies` |
14 | | -- Database: `SQLite`, PgSQL, MySql |
15 | | -- **Authentication** |
16 | | - - `Session-Based authentication` |
17 | | - - `Social Login`: **Github** & **Google** |
18 | | -- **User Extended profile** |
19 | | -- **API** via DRF |
20 | | -- DataTables |
21 | | -- Charts |
22 | | -- Celery |
23 | | -- File Manager |
24 | | -- i18n (internationalization) |
25 | | -- `Docker` |
| 14 | +- Simple, Easy-to-Extend Codebase |
| 15 | +- [Berry Dashboard](https://app-generator.dev/product/berry-dashboard/) Design Integration |
| 16 | +- Bootstrap Styling |
| 17 | +- DB Persistence: SQLite (default), can be used with MySQL, PostgreSQL |
| 18 | +- Extended User Profiles |
| 19 | +- Authentication |
| 20 | + - Session-based |
| 21 | + - OAuth GitHub, Google |
| 22 | +- Apps: |
| 23 | + - [DEMO](https://django-berry-pro.onrender.com/dynamic-dt/product/) **Dynamic DataTables** - generate server-side datatables without coding |
| 24 | + - [DEMO](https://django-berry-pro.onrender.com/api/product/) **Dynamic APIs** - Expose secure APIs without coding |
| 25 | + - [DEMO](https://django-berry-pro.onrender.com/charts/) **Charts** - powered by ApexCharts |
| 26 | + - [DEMO](https://django-berry-pro.onrender.com/react-charts) **React Integration** |
| 27 | + - **Media Files Manager** - empower users to manage and preview files with ease |
| 28 | + - **Celery** (async tasks) |
| 29 | +- [Django CLI Package](https://app-generator.dev/docs/developer-tools/django-cli/index.html) |
| 30 | + - `Commit/rollback Git Changes` |
| 31 | + - `Backup & restore DB` |
| 32 | + - `Interact with Django Core` |
| 33 | + - `Manage Environment` |
| 34 | + - `Manage Dependencies` |
| 35 | +- [Deployment](https://app-generator.dev/docs/deployment.html) |
| 36 | + - Docker/Docker Compose Scripts |
| 37 | + - CI/CD for [Render](https://app-generator.dev/docs/deployment/render/index.html) |
| 38 | +- [Vite](https://app-generator.dev/docs/technologies/vite/index.html) for assets management |
| 39 | + |
| 40 | +<br /> |
| 41 | + |
| 42 | +## [Documentation](https://app-generator.dev/docs/products/django/berry-pro/index.html) |
| 43 | + |
| 44 | +- Understand the codebase structure |
| 45 | +- Prepare the environment |
| 46 | +- Setting Up the Database |
| 47 | +- Start the Project |
| 48 | +- Switch from SQLite to MySql or PgSql |
| 49 | +- Add a new model and migrate database |
| 50 | +- Enable `Dynamic Tables` for a new model |
| 51 | +- Enable `Dynamic API` for a new model |
| 52 | +- Deploy on Render |
26 | 53 |
|
27 | 54 |  |
28 | 55 |
|
29 | 56 | <br /> |
30 | 57 |
|
31 | | -## Start in `Docker` |
| 58 | +## `Customize` with [Django App Generator](https://app-generator.dev/tools/django-generator/) |
32 | 59 |
|
33 | | -> **Step 1** - Download the [code](https://appseed.us/product/berry-dashboard-pro/django/) and unzip the sources (requires a `purchase`). |
| 60 | +- Access the [App Generator](https://app-generator.dev/tools/django-generator/) page |
| 61 | +- Select the preferred design |
| 62 | +- (Optional) Design Database: edit models and fields |
| 63 | +- (Optional) Edit the fields for the extended user model |
| 64 | +- (Optional) Enable OAuth for GitHub |
| 65 | +- (Optional) Add Celery (async tasks) |
| 66 | +- (Optional) Enable Dynamic API Module |
| 67 | +- Docker Scripts |
| 68 | +- Render CI/Cd Scripts |
34 | 69 |
|
35 | | -```bash |
36 | | -$ unzip django-berry-pro.zip |
37 | | -$ cd django-berry-pro |
38 | | -``` |
| 70 | +**The generated Django project is available as a ZIP Archive and also uploaded to GitHub.** |
39 | 71 |
|
40 | | -<br /> |
41 | | - |
42 | | -> **Step 2** - Start the APP in `Docker` |
43 | | -
|
44 | | -```bash |
45 | | -# Optional (kill all existing containers) |
46 | | -$ docker container kill $(docker ps -q) ; docker container rm $(docker ps -a -q) ; docker network prune -f |
47 | | -# Start the APP |
48 | | -$ docker-compose up --build |
49 | | -``` |
50 | | - |
51 | | -Visit `http://localhost:5085` in your browser. The app should be up & running. |
52 | | - |
53 | | -<br /> |
54 | | - |
55 | | -## Create new `.env` from `env.sample` |
56 | | - |
57 | | -The meaning of each variable can be found below: |
58 | | - |
59 | | -- `DEBUG`: if `True` the app runs in develoment mode |
60 | | - - For production value `False` should be used |
61 | | -- `MYSQL` credentials |
62 | | - - `DB_ENGINE`, default value = `mysql` |
63 | | - - `DB_NAME`, default value = `appseed_db` |
64 | | - - `DB_HOST`, default value = `localhost` |
65 | | - - `DB_PORT`, default value = `3306` |
66 | | - - `DB_USERNAME`, default value = `appseed_db_usr` |
67 | | - - `DB_PASS`, default value = `pass` |
68 | | -- `OAuth` via Github |
69 | | - - `GITHUB_ID`=<GITHUB_ID_HERE> |
70 | | - - `GITHUB_SECRET`=<GITHUB_SECRET_HERE> |
71 | | -- `OAuth` via Google |
72 | | - - `GOOGLE_CLIENT_ID`=<GOOGLE_ID_HERE> |
73 | | - - `GOOGLE_SECRET_KEY`=<GOOGLE_SECRET_HERE> |
74 | | - |
75 | | -<br /> |
76 | | - |
77 | | -## Manual Build |
78 | | - |
79 | | -> **Step 1** - Download the [code](https://appseed.us/product/berry-dashboard-pro/django/) and unzip the sources (requires a `purchase`). |
80 | | -
|
81 | | -```bash |
82 | | -$ unzip django-berry-pro.zip |
83 | | -$ cd django-berry-pro |
84 | | -``` |
85 | | - |
86 | | -<br /> |
87 | | - |
88 | | -### 👉 Set Up for `Unix`, `MacOS` |
89 | | - |
90 | | -> Install modules via `VENV` |
91 | | -
|
92 | | -```bash |
93 | | -$ virtualenv env |
94 | | -$ source env/bin/activate |
95 | | -$ pip3 install -r requirements.txt |
96 | | -``` |
97 | | - |
98 | | -<br /> |
99 | | - |
100 | | -> Set Up Database |
101 | | -
|
102 | | -```bash |
103 | | -$ python manage.py makemigrations |
104 | | -$ python manage.py migrate |
105 | | -``` |
106 | | - |
107 | | -<br /> |
108 | | - |
109 | | -> Create Superuser |
110 | | -
|
111 | | -```bash |
112 | | -$ python manage.py createsuperuser |
113 | | -``` |
114 | | - |
115 | | -<br /> |
116 | | - |
117 | | -> Start the app |
118 | | -
|
119 | | -```bash |
120 | | -$ python manage.py runserver |
121 | | -``` |
122 | | - |
123 | | -At this point, the app runs at `http://127.0.0.1:8000/`. |
124 | | - |
125 | | -<br /> |
126 | | - |
127 | | -### 👉 Set Up for `Windows` |
128 | | - |
129 | | -> Install modules via `VENV` (windows) |
130 | | -
|
131 | | -``` |
132 | | -$ virtualenv env |
133 | | -$ .\env\Scripts\activate |
134 | | -$ pip3 install -r requirements.txt |
135 | | -``` |
136 | | - |
137 | | -<br /> |
138 | | - |
139 | | -> Set Up Database |
140 | | -
|
141 | | -```bash |
142 | | -$ python manage.py makemigrations |
143 | | -$ python manage.py migrate |
144 | | -``` |
145 | | - |
146 | | -<br /> |
147 | | - |
148 | | -> Start the app |
149 | | -
|
150 | | -```bash |
151 | | -$ python manage.py runserver |
152 | | -``` |
153 | | - |
154 | | -At this point, the app runs at `http://127.0.0.1:8000/`. |
155 | | - |
156 | | -<br /> |
157 | | - |
158 | | -### 👉 Create Users |
159 | | - |
160 | | -By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: |
161 | | - |
162 | | -- Start the app |
163 | | -- Access the `registration` page and create a new user: |
164 | | - - `http://127.0.0.1:8000/register/` |
165 | | -- Access the `sign in` page and authenticate |
166 | | - - `http://127.0.0.1:8000/login/` |
167 | | - |
168 | | -<br /> |
169 | | - |
170 | | -## Start Celery (async task) |
171 | | - |
172 | | -- Make sure you have a Redis Server running: `redis://localhost:6379` |
173 | | - - `$ redis-cli` and type `ping` |
174 | | -- In the base directory inside `tasks_scripts` folder you need to write your scripts file. |
175 | | -- Run the celery command from the CLI. |
176 | | - |
177 | | -```bash |
178 | | -$ export DJANGO_SETTINGS_MODULE="core.settings" |
179 | | -$ celery -A apps.tasks worker -l info -B |
180 | | -``` |
181 | | - |
182 | | -- You will see a new route `Apps -> Tasks` in the sidebar. |
183 | | -- You can start and cancel any task from the UI. |
184 | | - |
185 | | -<br /> |
186 | | - |
187 | | -## Enable Social Login |
188 | | - |
189 | | -> 👉 **Github Setup** - [Create an OAuth App](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) |
190 | | -
|
191 | | -- SignIN to `Github` |
192 | | -- Access `Settings` -> `Developer Settings` -> `OAuth Apps` |
193 | | -- Edit your OAuth App |
194 | | - - `App Name` |
195 | | - - `App Description` |
196 | | - - (mandatory) `HomePage`: `https://localhost:8000` |
197 | | - - (mandatory) `Authorization callback URL`: `https://localhost:8000/` |
198 | | - - Generate a new `secret key` |
199 | | - |
200 | | -<br /> |
| 72 | + |
201 | 73 |
|
202 | | -## Codebase |
203 | | - |
204 | | -The project is coded using a simple and intuitive structure presented below: |
205 | | - |
206 | | -```bash |
207 | | -< PROJECT ROOT > |
208 | | - | |
209 | | - |-- core/ # Implements app configuration |
210 | | - | |-- settings.py # Defines Global Settings |
211 | | - | |-- wsgi.py # Start the app in production |
212 | | - | |-- urls.py # Define URLs served by all apps/nodes |
213 | | - | |
214 | | - |-- home/ # Serves all pages from the UI Kit |
215 | | - | |
216 | | - |-- apps/ |
217 | | - | | |
218 | | - | |-- common/ # Assets used by all APPS (models, helpers) |
219 | | - | |-- users/ # Handles Auth Flow |
220 | | - | |-- api/ # DRF API |
221 | | - | |-- charts/ # Charts APP |
222 | | - | |-- tables/ # DataTables APP |
223 | | - | |-- tasks/ # Celery App |
224 | | - | |
225 | | - |-- templates/ # Pages & Templates |
226 | | - |-- assets/ # Static Assets [ JS, CSS, images ] |
227 | | - | |
228 | | - |-- requirements.txt # Development modules - SQLite storage |
229 | | - | |
230 | | - |-- .env # Environment |
231 | | - |-- env.sample # Environment Sample |
232 | | - | |
233 | | - |-- manage.py # Django Manager File |
234 | | - | |
235 | | - |-- ************************************************************************ |
236 | | -``` |
| 74 | + |
237 | 75 |
|
238 | 76 | <br /> |
239 | 77 |
|
240 | 78 | --- |
241 | | -[Django Berry PRO](https://appseed.us/product/berry-dashboard-pro/django/) - Starter crafted by **[AppSeed](https://appseed.us/)**. |
| 79 | +[Django Berry PRO](https://appseed.us/product/berry-dashboard-pro/django/) - Premium **Django** Starter provided by [App Generator](https://app-generator.dev). |
0 commit comments