https://github.com/app-generator/django-simple-charts
Django Simple Charts - Open-Source Sample | AppSeed
https://github.com/app-generator/django-simple-charts
appseed-sample django-charts
Last synced: 3 months ago
JSON representation
Django Simple Charts - Open-Source Sample | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/django-simple-charts
- Owner: app-generator
- License: other
- Created: 2023-04-25T14:04:20.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T19:29:44.000Z (about 2 years ago)
- Last Synced: 2025-02-05T20:56:32.486Z (4 months ago)
- Topics: appseed-sample, django-charts
- Language: CSS
- Homepage: https://docs.appseed.us/technologies/django/charts-simple/
- Size: 14 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Django Simple Charts](https://docs.appseed.us/technologies/django/charts-simple/)
Open-source **Django** project crafted on top of **[Material Dashboard](https://appseed.us/product/material-dashboard/django/)**, an open-source `Boostrap 5` design from [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200)
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.
- 👉 [Django Material Dashboard](https://appseed.us/product/material-dashboard/django/) - `Product page`
- 👉 [Django Material Dashboard](https://django-material-dash2.onrender.com) - `LIVE Demo`
- 🛒 **[Django Material Dashboard PRO](https://appseed.us/product/material-dashboard2-pro/django/)** - `Premium Version`
> Features:
- ✅ `Up-to-date Dependencies`
- ✅ Theme: [Django Admin Material](https://github.com/app-generator/django-admin-material-dashboard), **designed by [Creative-Tim](https://www.creative-tim.com/product/material-dashboard?AFFILIATE=128200)**
- `can be used in any Django project` (new or legacy)
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
- 🚀 `Deployment`
- `CI/CD` flow via `Render`
## Manual Build
> 👉 Download the code
```bash
$ git clone https://github.com/app-generator/django-material-dashboard.git
$ cd django-material-dashboard
```
> 👉 Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
```
> 👉 Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
> 👉 Create the Superuser
```bash
$ python manage.py createsuperuser
```
> 👉 Start the app
```bash
$ python manage.py runserver
```
At this point, the app runs at `http://127.0.0.1:8000/`.
## Codebase structure
The project is coded using a simple and intuitive structure presented below:
```bash
< PROJECT ROOT >
|
|-- core/
| |-- settings.py # Project Configuration
| |-- urls.py # Project Routing
|
|-- home/
| |-- views.py # APP Views
| |-- urls.py # APP Routing
| |-- models.py # APP Models
| |-- tests.py # Tests
| |-- templates/ # Theme Customisation
| |-- includes #
| |-- custom-footer.py # Custom Footer
|
|-- requirements.txt # Project Dependencies
|
|-- env.sample # ENV Configuration (default values)
|-- manage.py # Start the app - Django default start script
|
|-- ************************************************************************
```
## How to Customize
When a template file is loaded, `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.
The theme used to style this starter provides the following files:
```bash
# This exists in ENV: LIB/admin_material
< UI_LIBRARY_ROOT >
|
|-- templates/ # Root Templates Folder
| |
| |-- accounts/
| | |-- login.html # Sign IN Page
| | |-- register.html # Sign UP Page
| |
| |-- includes/
| | |-- footer.html # Footer component
| | |-- sidebar.html # Sidebar component
| | |-- navigation.html # Navigation Bar
| | |-- scripts.html # Scripts Component
| |
| |-- layouts/
| | |-- base.html # Masterpage
| | |-- base-auth.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Dashboard Page
| |-- profile.html # Profile Page
| |-- *.html # All other pages
|
|-- ************************************************************************
```
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.
> For instance, if we want to **customize the footer.html** these are the steps:
- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app
- ✅ `Step 2`: configure the project to use this new template directory
- `core/settings.py` TEMPLATES section
- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
- Source PATH: `/LIB/admin_material/template/includes/footer.html`
- Destination PATH: `home/templates/includes/footer.html`
> 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:
`home/templates/includes/custom_footer.html`
By default, this file is unused because the `theme` expects `footer.html` (without the `custom-` prefix).
In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django.
In a similar way, all other files and components can be customized easily.
## CSS Styling
The UI can be customized via the SCSS file. This setup was tested using:
- `Node` v16.15.0
- `Yarn` 1.22.18
- `Gulp` CLI version: `2.3.0`, Local version: `4.0.2`
```bash
$ cd static
$ yarn # Install Modules
$ vi scss/material-dashboard/_variables.scss # Edit primary, secondary colors
$ gulp # Regenerate CSS files
```
> NOTE, once the CSS files are successfully regenerated, force a hard refresh in the browser (Shift + F5 in Chrome).
The relevant lines in `_variables.scss` are highlighted below:
```SCSS
// _variables.scss, LINES 56 -> 63
$primary: #e91e63 !default; // EDIT & Recompile SCSS
$secondary: #7b809a !default; // EDIT & Recompile SCSS
$info: #1A73E8 !default; // EDIT & Recompile SCSS
$success: #4CAF50 !default; // EDIT & Recompile SCSS
$warning: #fb8c00 !default; // EDIT & Recompile SCSS
$danger: #F44335 !default; // EDIT & Recompile SCSS
$light: $gray-200 !default; // EDIT & Recompile SCSS
$dark: $h-color !default; // EDIT & Recompile SCSS
```
## Deploy on [Render](https://render.com/)
- Create a Blueprint instance
- Go to https://dashboard.render.com/blueprints this link.
- Click `New Blueprint Instance` button.
- Connect your `repo` which you want to deploy.
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
- After that your deployment will start automatically.
At this point, the product should be LIVE.
## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)
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.
> Features:
- ✅ `Up-to-date Dependencies`
- ✅ `Design`: [Django Theme Material2](https://github.com/app-generator/django-admin-material2-pro) - `PRO Version`
- ✅ `Sections` covered by the design:
- ✅ **Admin section** (reserved for superusers)
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
- ✅ **All Pages** available in for ordinary users
- ✅ `Docker`
- 🚀 `Deployment`
- `CI/CD` flow via `Render`
---
[Django Simple Charts](https://docs.appseed.us/technologies/django/charts-simple/) - Minimal **Django** core provided by **[AppSeed](https://appseed.us/)**