Skip to content

Commit bcea4d4

Browse files
app-generatorapp-generator
committed
v1.0.16 - Update RM Links
1 parent 0aca956 commit bcea4d4

File tree

2 files changed

+35
-211
lines changed

2 files changed

+35
-211
lines changed

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Change Log
22

3+
## [1.0.16] 2024-11-24
4+
### Changes
5+
6+
- Update RM Links
7+
- 👉 [Django Argon Dashboard](https://app-generator.dev/docs/products/django/argon-dashboard/index.html) - **Complete Documentation**
8+
- 👉 [Django Argon Dashboard PRO](https://app-generator.dev/product/argon-dashboard-pro/django/) - The premium version
9+
310
## [1.0.15] 2024-05-18
411
### Changes
512

‎README.md

+28-211
Original file line numberDiff line numberDiff line change
@@ -1,229 +1,46 @@
1-
# [Django Argon Dashboard](https://appseed.us/product/argon-dashboard/django/)
1+
# [Django Argon Dashboard](https://app-generator.dev/product/argon-dashboard/django/)
22

3-
Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** project crafted on top of **Argon Dashboard**, an open-source `Bootstrap 5` design from Creative-Tim.
4-
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. `Material Material` has easy and intuitive responsive design whether it is viewed on retina screens or laptops.
3+
Free starter built on top of **Bootstrap and Django** with database, authentication, and Docker support. The **Argon Dashboard** design is crafted by `Creative-Tim` using Bootstrap 5 Framework.
4+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
55

6-
- 👉 [Django Argon Dashboard](https://appseed.us/product/argon-dashboard/django/) - `Product page`
7-
- 👉 [Django Argon Dashboard](https://django-argon-dash2.onrender.com) - `LIVE Demo`
6+
- 👉 [Django Argon Dashboard](https://app-generator.dev/docs/products/django/argon-dashboard/index.html) - **Complete Documentation**
7+
- 👉 [Django Argon Dashboard](https://django-argon-dash2.onrender.com/) - LIVE Demo
8+
- 👉 [Get Support](https://app-generator.dev/ticket/create/) via Email and Discord
89

910
<br />
1011

1112
## Features
1213

13-
> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed**
14+
- Simple, Easy-to-Extend codebase
15+
- [Argon Dashboard](https://app-generator.dev/docs/templates/bootstrap/argon-dashboard.html) - Full Integration
16+
- Bootstrap 4 Styling
17+
- Session-based Authentication
18+
- DB Persistence: SQLite/MySql/PostgreSQL
19+
- Docker
20+
- CI/CD integration for Render
1421

15-
| Free Version | [PRO Version](https://appseed.us/product/argon-dashboard2-pro/django/) | [Custom Development](https://appseed.us/custom-development/) |
16-
| --------------------------------------| --------------------------------------| --------------------------------------|
17-
| ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: |
18-
| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1 Week** `Custom Development` |
19-
| ✓ Bootstrap 5, `Material` Design | ✅ `OAuth` GitHub | ✅ **Team**: PM, Developer, Tester |
20-
| ✓ `CI/CD` Flow via Render | ✅ `API`, **[Charts](https://django-argon-dash2-pro.onrender.com/charts/)** | ✅ Weekly Sprints |
21-
| ✓ `Docker` | ✅ **[DataTables](https://django-argon-dash2-pro.onrender.com/tables/)** (Filters, Export) | ✅ Technical SPECS |
22-
| ✓ `Free Support` (GitHub Issues) |✅ **Celery** | ✅ Documentation |
23-
| - | ✅ **Media Files Manager** | ✅ **30 days Delivery Warranty** |
24-
| - | ✅ **Extended User Profiles** | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** |
25-
| - | ✅ `Private REPO Access` | - |
26-
| - | ✅ **[Premium Support](https://appseed.us/support/)** | - |
27-
| ------------------------------------ | ------------------------------------ | ------------------------------------|
28-
| ✓ [LIVE Demo](https://django-argon-dash2.onrender.com) | 🚀 [LIVE Demo](https://django-argon-dash2-pro.onrender.com/) | **[Get in Touch ➡️](https://appseed.us/custom-development/)** |
29-
30-
![Argon Dashboard 2 - Free Starter.](https://user-images.githubusercontent.com/51070104/215804889-94eba681-8262-41a3-8e57-7d5b12dcc209.png)
31-
32-
<br />
33-
34-
## Manual Build
35-
36-
> 👉 Download the code
37-
38-
```bash
39-
$ git clone https://github.com/app-generator/django-argon-dashboard.git
40-
$ cd django-argon-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-
> 👉 Set Up Database
56-
57-
```bash
58-
$ python manage.py makemigrations
59-
$ python manage.py migrate
60-
```
61-
62-
<br />
63-
64-
> 👉 Create the Superuser
65-
66-
```bash
67-
$ python manage.py createsuperuser
68-
```
69-
70-
<br />
71-
72-
> 👉 Start the app
73-
74-
```bash
75-
$ python manage.py runserver
76-
```
77-
78-
At this point, the app runs at `http://127.0.0.1:8000/`.
79-
80-
<br />
81-
82-
## Codebase structure
83-
84-
The project is coded using a simple and intuitive structure presented below:
85-
86-
```bash
87-
< PROJECT ROOT >
88-
|
89-
|-- core/
90-
| |-- settings.py # Project Configuration
91-
| |-- urls.py # Project Routing
92-
|
93-
|-- home/
94-
| |-- views.py # APP Views
95-
| |-- urls.py # APP Routing
96-
| |-- models.py # APP Models
97-
| |-- tests.py # Tests
98-
| |-- templates/ # Theme Customisation
99-
| |-- includes #
100-
| |-- custom-footer.py # Custom Footer
101-
|
102-
|-- requirements.txt # Project Dependencies
103-
|
104-
|-- env.sample # ENV Configuration (default values)
105-
|-- manage.py # Start the app - Django default start script
106-
|
107-
|-- ************************************************************************
108-
```
22+
![Django Argon Dashboard - Open-Source Django Starter](https://user-images.githubusercontent.com/51070104/215804889-94eba681-8262-41a3-8e57-7d5b12dcc209.png)
10923

11024
<br />
11125

112-
## How to Customize
26+
## [Argon Dashboard PRO Version](https://app-generator.dev/product/argon-dashboard-pro/django/)
11327

114-
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.
115-
The theme used to style this starter provides the following files:
28+
> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-argon-dash2-pro.onrender.com/charts/)
11629
117-
```bash
118-
# This exists in ENV: LIB/admin_argon
119-
< UI_LIBRARY_ROOT >
120-
|
121-
|-- templates/ # Root Templates Folder
122-
| |
123-
| |-- accounts/
124-
| | |-- sign-in.html # Sign IN Page
125-
| | |-- sign-up.html # Sign UP Page
126-
| |
127-
| |-- includes/
128-
| | |-- footer.html # Footer component
129-
| | |-- sidebar.html # Sidebar component
130-
| | |-- navigation.html # Navigation Bar
131-
| | |-- scripts.html # Scripts Component
132-
| |
133-
| |-- layouts/
134-
| | |-- base.html # Masterpage
135-
| | |-- base-fullscreen.html # Masterpage for Auth Pages
136-
| |
137-
| |-- pages/
138-
| |-- dashboard.html # Dashboard page
139-
| |-- profile.html # Settings Page
140-
| |-- *.html # All other pages
141-
|
142-
|-- ************************************************************************
143-
```
144-
145-
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.
146-
147-
> For instance, if we want to **customize the footer.html** these are the steps:
148-
149-
- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app
150-
- ✅ `Step 2`: configure the project to use this new template directory
151-
- `core/settings.py` TEMPLATES section
152-
- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
153-
- Source PATH: `<YOUR_ENV>/LIB/admin_argon/includes/footer.html`
154-
- Destination PATH: `<PROJECT_ROOT>home/templates/includes/footer.html`
155-
156-
> 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:
157-
158-
`home/templates/includes/custom_footer.html`
159-
160-
By default, this file is unused because the `theme` expects `footer.html` (without the `custom-` prefix).
161-
162-
In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django.
163-
164-
In a similar way, all other files and components can be customized easily.
165-
166-
<br />
167-
168-
## Recompile SCSS
169-
170-
The SCSS/CSS files used to style the Ui are saved in the `static/assets` directory.
171-
In order to update the Ui colors (primary, secondary) this procedure needs to be followed.
172-
173-
```bash
174-
$ yarn # install modules
175-
$ # # edit variables
176-
$ vi static/assets/scss/argon-dashboard/custom/_variables.scss
177-
$ gulp # SCSS to CSS translation
178-
```
179-
180-
The `_variables.scss` content defines the `primary` and `secondary` colors:
181-
182-
```scss
183-
$primary: #5e72e4 !default; // EDIT for customization
184-
$secondary: #8392ab !default; // EDIT for customization
185-
$info: #11cdef !default; // EDIT for customization
186-
$success: #2dce89 !default; // EDIT for customization
187-
$warning: #fb6340 !default; // EDIT for customization
188-
$danger: #f5365c !default; // EDIT for customization
189-
```
190-
191-
<br />
192-
193-
## Deploy on [Render](https://render.com/)
194-
195-
- Create a Blueprint instance
196-
- Go to https://dashboard.render.com/blueprints this link.
197-
- Click `New Blueprint Instance` button.
198-
- Connect your `repo` which you want to deploy.
199-
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
200-
- After that your deployment will start automatically.
201-
202-
At this point, the product should be LIVE.
203-
204-
<br />
205-
206-
## [PRO Version](https://appseed.us/product/argon-dashboard2-pro/django/)
207-
208-
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. `Argon 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.
209-
210-
> Features:
211-
212-
- ✅ `Up-to-date Dependencies`
213-
- ✅ `Design`: Django Theme Argon 2 - `PRO Version`
214-
- ✅ `Sections` covered by the design:
215-
- ✅ **Admin section** (reserved for superusers)
216-
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
217-
- ✅ **All Pages** available in for ordinary users
218-
- ✅ `Docker`
219-
- 🚀 `Deployment`
220-
- `CI/CD` flow via `Render`
221-
222-
<br />
30+
- **Simple, Easy-to-Extend** Codebase
31+
- **Argon Dashboard** Design
32+
- **OAuth** - Github
33+
- **Extended User Profile**
34+
- **API** via DRF
35+
- **Charts** via ApexJS
36+
- **React Integration** (new)
37+
- **DataTables**
38+
- **Celery** (async tasks)
39+
- **Deployment-Ready** for Render
22340

224-
![Argon Dashboard 2 PRO - Automotive (Premium Bootstrap 5 Design).](https://user-images.githubusercontent.com/51070104/211158013-fea76b79-bb54-4066-a617-5ec3b4b6ec42.jpg)
41+
![Django Argon Dashboard - The premium version](https://github.com/user-attachments/assets/e2bca541-ed94-4369-8ab7-361a7f112e69)
22542

22643
<br />
22744

22845
---
229-
[Django Argon Dashboard](https://appseed.us/product/argon-dashboard/django/) - Minimal **Django** core provided by **[AppSeed](https://appseed.us/)**
46+
[Django Argon Dashboard](https://app-generator.dev/product/argon-dashboard/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev)

0 commit comments

Comments
 (0)