|
1 | | -# [Django Berry Dashboard](https://appseed.us/product/berry-dashboard/django/) |
2 | 1 |
|
3 | | -Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** crafted on top of **Berry Dashboard**, an open-source `Boostrap 5` design from `CodedThemes`. The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. `Berry` has an easy and intuitive responsive design whether it is viewed on retina screens or laptops. |
| 2 | +# [Django Berry Dashboard](https://app-generator.dev/product/berry-dashboard/django/) |
4 | 3 |
|
5 | | -- 👉 [Django Berry](https://appseed.us/product/berry-dashboard/django/) - `Product page` |
6 | | -- 👉 [Django Berry](https://django-berry.onrender.com) - `LIVE Demo` |
| 4 | +Open-source **Django** project crafted on top of **Berry Dashboard Dashboard**, an open-source `Bootstrap` design. |
| 5 | +The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. |
7 | 6 |
|
8 | | -<br /> |
9 | | - |
10 | | -## Features |
11 | | - |
12 | | -> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed** |
13 | | -
|
14 | | -| Free Version | [PRO Version](https://appseed.us/product/berry-dashboard-pro/django/) | [Custom Development](https://appseed.us/custom-development/) | |
15 | | -| --------------------------------------| --------------------------------------| --------------------------------------| |
16 | | -| ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: | |
17 | | -| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1mo Custom Development** | |
18 | | -| ✓ Bootstrap 5, `Material` Design | ✅ `OAuth` Google, GitHub | ✅ **Team**: PM, Developer, Tester | |
19 | | -| ✓ `CI/CD` Flow via Render | ✅ `API`, **Charts** | ✅ Weekly Sprints | |
20 | | -| ✓ `Docker` | ✅ **DataTables** (Filters, Export) | ✅ Technical SPECS | |
21 | | -| - |✅ **Celery** | ✅ Documentation | |
22 | | -| - | ✅ **Media Files Manager** | ✅ **30 days Delivery Warranty** | |
23 | | -| - | ✅ **Extended User Profiles** | - | |
24 | | -| - | ✅ `Private REPO Access` | - | |
25 | | -| - | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/) | - | |
26 | | -| - | ✅ Deployment Assistance | - | |
27 | | -| ------------------------------------ | ------------------------------------ | ------------------------------------| |
28 | | -| ✓ [LIVE Demo](https://django-berry.onrender.com) | 🚀 [LIVE Demo](https://django-berry-pro.onrender.com) | 🛒 `Order`: **[$3,999](https://appseed.gumroad.com/l/rocket-package)** (GUMROAD) | |
29 | | - |
30 | | - |
31 | | - |
32 | | -<br /> |
33 | | - |
34 | | -## Manual Build |
35 | | - |
36 | | -> 👉 Download the code |
37 | | -
|
38 | | -```bash |
39 | | -$ git clone https://github.com/app-generator/django-berry-dashboard.git |
40 | | -$ cd django-berry-dashboard |
41 | | -``` |
42 | | - |
43 | | -<br /> |
44 | | - |
45 | | -> 👉 Install modules via `VENV` |
46 | | -
|
47 | | -```bash |
48 | | -$ virtualenv env |
49 | | -$ source env/bin/activate |
50 | | -$ pip install -r requirements.txt |
51 | | -``` |
52 | | - |
53 | | -<br /> |
54 | | - |
55 | | -> 👉 Edit the `.env` using the template `.env.sample`. |
56 | | -
|
57 | | -```env |
58 | | -
|
59 | | -# True for development, False for production |
60 | | -DEBUG=True |
61 | | -
|
62 | | -``` |
63 | | - |
64 | | -<br /> |
65 | | - |
66 | | -> 👉 Set Up Database |
67 | | -
|
68 | | -```bash |
69 | | -$ python manage.py makemigrations |
70 | | -$ python manage.py migrate |
71 | | -``` |
72 | | - |
73 | | -<br /> |
74 | | - |
75 | | -> 👉 Create the Superuser |
76 | | -
|
77 | | -```bash |
78 | | -$ python manage.py createsuperuser |
79 | | -``` |
80 | | - |
81 | | -<br /> |
82 | | - |
83 | | -> 👉 Start the app |
84 | | -
|
85 | | -```bash |
86 | | -$ python manage.py runserver |
87 | | -``` |
88 | | - |
89 | | -At this point, the app runs at `http://127.0.0.1:8000/`. |
90 | | - |
91 | | -<br /> |
92 | | - |
93 | | -## Codebase structure |
94 | | - |
95 | | -The project is coded using a simple and intuitive structure presented below: |
96 | | - |
97 | | -```bash |
98 | | -< PROJECT ROOT > |
99 | | - | |
100 | | - |-- core/ |
101 | | - | |-- settings.py # Project Configuration |
102 | | - | |-- urls.py # Project Routing |
103 | | - | |
104 | | - |-- home/ |
105 | | - | |-- views.py # APP Views |
106 | | - | |-- urls.py # APP Routing |
107 | | - | |-- models.py # APP Models |
108 | | - | |-- tests.py # Tests |
109 | | - | |-- templates/ # Theme Customisation |
110 | | - | |-- includes # |
111 | | - | |-- custom-footer.py # Custom Footer |
112 | | - | |
113 | | - |-- requirements.txt # Project Dependencies |
114 | | - | |
115 | | - |-- env.sample # ENV Configuration (default values) |
116 | | - |-- manage.py # Start the app - Django default start script |
117 | | - | |
118 | | - |-- ************************************************************************ |
119 | | -``` |
| 7 | +- 👉 [Django Berry Dashboard](https://app-generator.dev/docs/products/django/berry/index.html) - **Complete Documentation** |
| 8 | +- 👉 [Django Berry Dashboard](https://django-berry.onrender.com/) - LIVE Demo |
| 9 | +- 👉 [Get Support](https://app-generator.dev/ticket/create/) via Email and Discord |
120 | 10 |
|
121 | 11 | <br /> |
122 | 12 |
|
123 | | -## How to Customize |
124 | | - |
125 | | -When a template file is loaded in the controller, `Django` scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found. |
126 | | -The theme used to style this starter provides the following files: |
127 | | - |
128 | | -```bash |
129 | | -# This is saved in ENV: LIB/admin_berry |
130 | | -< UI_LIBRARY_ROOT > |
131 | | - | |
132 | | - |-- templates/ # Root Templates Folder |
133 | | - | | |
134 | | - | |-- accounts/ |
135 | | - | | |-- login.html # Sign IN Page |
136 | | - | | |-- register.html # Sign UP Page |
137 | | - | | |
138 | | - | |-- includes/ |
139 | | - | | |-- footer.html # Footer component |
140 | | - | | |-- sidebar.html # Sidebar component |
141 | | - | | |-- navigation.html # Navigation Bar |
142 | | - | | |-- scripts.html # Scripts Component |
143 | | - | | |
144 | | - | |-- layouts/ |
145 | | - | | |-- base.html # Masterpage |
146 | | - | | |-- auth_base.html # Masterpage for Auth Pages |
147 | | - | | |
148 | | - | |-- pages/ |
149 | | - | |-- index.html # Dashboard page |
150 | | - | |-- color.html # Colors Page |
151 | | - | |-- *.html # All other pages |
152 | | - | |
153 | | - |-- ************************************************************************ |
154 | | -``` |
155 | | - |
156 | | -When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path. |
157 | | - |
158 | | -> For instance, if we want to **customize the footer.html** these are the steps: |
159 | | -
|
160 | | -- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app |
161 | | -- ✅ `Step 2`: configure the project to use this new template directory |
162 | | - - `core/settings.py` TEMPLATES section |
163 | | -- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR |
164 | | - - Source PATH: `<YOUR_ENV>/LIB/admin_berry/includes/footer.html` |
165 | | - - Destination PATH: `<PROJECT_ROOT>home/templates/includes/footer.html` |
166 | | - |
167 | | -> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom footer` can be found at this location: |
168 | | -
|
169 | | -`home/templates/includes/custom_footer.html` |
170 | | - |
171 | | -By default, this file is unused because the `theme` expects `footer.html` (without the `custom_` prefix). |
172 | | - |
173 | | -In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django. |
174 | | - |
175 | | -In a similar way, all other files and components can be customized easily. |
176 | | - |
177 | | -<br /> |
178 | | - |
179 | | -## Deploy on [Render](https://render.com/) |
180 | | - |
181 | | -- Create a Blueprint instance |
182 | | - - Go to https://dashboard.render.com/blueprints this link. |
183 | | -- Click `New Blueprint Instance` button. |
184 | | -- Connect your `repo` which you want to deploy. |
185 | | -- Fill the `Service Group Name` and click on `Update Existing Resources` button. |
186 | | -- After that your deployment will start automatically. |
187 | | - |
188 | | -At this point, the product should be LIVE. |
189 | | - |
190 | | -<br /> |
191 | | - |
192 | | -## [PRO Version](https://appseed.us/product/berry-dashboard-pro/django/) |
193 | | - |
194 | | -This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design inspired by Google's Material Design. `Material Dashboard 2 PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining. |
195 | | - |
196 | | -> Features: |
197 | | -
|
198 | | -- `Up-to-date Dependencies` |
199 | | -- `Design`: [Django Theme Berry](https://github.com/app-generator/django-admin-berry-pro) - `PRO Version` |
200 | | -- `Sections` covered by the design: |
201 | | - - **Admin section** (reserved for superusers) |
202 | | - - **Authentication**: `Django.contrib.AUTH`, Registration |
203 | | - - **All Pages** available in for ordinary users |
204 | | -- `Docker`, `Deployment`: |
205 | | - - `CI/CD` flow via `Render` |
| 13 | +## Features |
206 | 14 |
|
207 | | -<br /> |
| 15 | +- **Django 4.1.12** |
| 16 | +- Best Practices |
| 17 | +- **Berry Dashboard Dashboard** - Full Integration |
| 18 | +- `CI/CD` Flow via Render |
| 19 | +- `Docker` |
208 | 20 |
|
209 | | - |
| 21 | + |
210 | 22 |
|
211 | 23 | <br /> |
212 | 24 |
|
213 | 25 | --- |
214 | | -[Django Berry Dashboard](https://appseed.us/product/berry-dashboard/django/) - Minimal **Django** starter provided by **[AppSeed](https://appseed.us/)** |
| 26 | +[Django Berry Dashboard](https://app-generator.dev/product/berry-dashboard/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev) |
0 commit comments