Skip to content

Commit 887a409

Browse files
author
App Generator
committed
README - Update help
1 parent 24545e8 commit 887a409

File tree

1 file changed

+43
-17
lines changed

1 file changed

+43
-17
lines changed

README.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Django Argon Charts
22

3-
Admin dashboard generated by AppSeed in **[Django](https://appseed.us/admin-dashboards/django)** Framework on top of **[Argon Dashboard](https://appseed.us/admin-dashboards/django-dashboard-argon-pro)** design. You will save a lot of time going from prototyping to full-functional code, because all elements are implemented. **Argon Dashboard** is coming with pre-built examples, so the development process is seamless switching from our pages to the real website is very easy to be done.
3+
Open-source **Django** Sample provided on top of **Argon Dashboard** design (free version). The sample provides functional code that shows different metrics regarding the sales in the last 12mo: total sales, total orders, best sale and best month (in sales value). Information is provided using charts, widgets and a paginated data table that allows to edit and add new sales.
44

55
<br />
66

7-
> App Features - **Status WIP**
7+
> App Features
88
99
- Manage orders and display the information visually using charts and widgets
1010
- Table `Orders` store the information - properties:
@@ -31,18 +31,18 @@ Admin dashboard generated by AppSeed in **[Django](https://appseed.us/admin-dash
3131

3232
> Links
3333
34-
- [Django Dashboard Argon](https://appseed.us/admin-dashboards/django-dashboard-argon) - product page
35-
- [Django Dashboard Argon - Demo](https://django-argon-dashboard.appseed-srv1.com/) - LIVE deployment
34+
- [Django Dashboard Argon - Demo](https://django-argon-charts.appseed-srv1.com) - LIVE deployment
35+
- [Django Dashboard Argon](https://www.creative-tim.com/product/argon-dashboard-django) - product page
3636

3737
<br />
3838

3939
## Want more? Go PRO!
4040

41-
PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Support** (via [Discord](https://discord.gg/fZC6hup))
41+
PRO versions include **Premium UI Kits**, updates and **Priority Support**
4242

43-
| [Django Datta PRO](https://appseed.us/admin-dashboards/django-dashboard-dattaable-pro) | [Django Material PRO](https://appseed.us/admin-dashboards/django-dashboard-material-pro) | [Django Volt PRO](https://appseed.us/admin-dashboards/django-dashboard-volt-pro) |
43+
| [Django Argon PRO](https://www.creative-tim.com/product/argon-dashboard-pro-django) | [Django Black PRO](https://www.creative-tim.com/product/black-dashboard-pro-django) | [Django Datta Able PRO](https://appseed.us/admin-dashboards/django-dashboard-dattaable-pro) |
4444
| --- | --- | --- |
45-
| [![Django Datta PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-dattaable-pro/master/media/django-dashboard-dattaable-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-dattaable-pro) | [![Django Material PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-material-pro/master/media/django-dashboard-material-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-material-pro) | [![Django Volt PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-volt-pro/master/media/django-dashboard-volt-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-volt-pro)
45+
| [![Django Argon PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-argon-pro/master/media/django-dashboard-argon-pro-screen.png)](https://www.creative-tim.com/product/argon-dashboard-pro-django) | [![Django Black PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-black-pro/master/media/django-dashboard-black-pro-screen.png)](https://www.creative-tim.com/product/black-dashboard-pro-django) | [![Django Datta PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-dattaable-pro/master/media/django-dashboard-dattaable-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-dattaable-pro)
4646

4747
<br />
4848
<br />
@@ -53,11 +53,19 @@ PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Suppo
5353

5454
## How to use it
5555

56+
**Clone the sources**
57+
5658
```bash
5759
$ # Get the code
5860
$ git clone https://github.com/app-generator/django-argon-charts.git
5961
$ cd django-argon-charts
60-
$
62+
```
63+
64+
<br />
65+
66+
**Prepare the environment** and install modules
67+
68+
```bash
6169
$ # Virtualenv modules installation (Unix based systems)
6270
$ virtualenv env
6371
$ source env/bin/activate
@@ -69,21 +77,37 @@ $
6977
$ # Install modules
7078
$ # SQLIte version
7179
$ pip3 install -r requirements.txt
72-
$
80+
```
81+
82+
<br />
83+
84+
**Create SQLite database** an tables
85+
86+
```bash
7387
$ # Create tables
7488
$ python manage.py makemigrations
7589
$ python manage.py migrate
90+
```
91+
92+
<br />
93+
94+
**Create the superuser**
95+
96+
```bash
97+
$ python manage.py createsuperuser
7698
$
77-
$ # Start the application (development mode)
78-
$ python manage.py runserver # default port 8000
79-
$
80-
$ # Start the app - custom port
81-
$ # python manage.py runserver 0.0.0.0:<your_port>
82-
$
83-
$ # Access the web app in browser: http://127.0.0.1:8000/
99+
$ # provide user, email and password
84100
```
85101

86-
> Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages.
102+
<br />
103+
104+
**Start the app**, access the `admin` section and import the [Sample File](https://github.com/app-generator/django-argon-charts/blob/master/media/sample_data/orders.csv) into the `orders` table.
105+
106+
> Note: make sure your are connected with an `admin` account.
107+
108+
<br />
109+
110+
![Django Argon Charts - how to import data using admin section.](https://raw.githubusercontent.com/app-generator/static/master/samples/django-argon-charts-import-data.gif)
87111

88112
<br />
89113

@@ -114,6 +138,8 @@ The project is coded using a simple and intuitive structure presented below:
114138
|-- app/ # A simple app that serve HTML files
115139
| |-- views.py # Serve HTML pages for authenticated users
116140
| |-- urls.py # Define some super simple routes
141+
| |-- templates
142+
| |-- dashboard.html # The dashboard <-------- NEW
117143
|
118144
|-- orders/ # Handles and display ORDERS <-------- NEW
119145
| |-- migrations/ # Handles and display ORDERS <-------- NEW

0 commit comments

Comments
 (0)