imran-helios / dashboard

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Open-source Django Dashboard generated by AppSeed op top of a modern design. Designed for those who like bold elements and beautiful websites, Soft UI Dashboard is ready to help you create stunning websites and webapps. Soft UI Dashboard is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.


UI Kit: https://github.com/creativetimofficial/soft-ui-dashboard-tailwind v1.0.4


Features

  • CSS Framework: Tailwind
  • Up-to-date dependencies
  • Database: sqlite
  • UI-Ready app, Django Native ORM
  • Session-Based authentication, Forms validation

Soft UI Dashboard - Full-Stack Starter generated by AppSeed.


✨ Start the app in Docker

Step 1 - Download the code from the GH repository (using GIT)

$ git clone https://github.com/app-generator/django-soft-dashboard-tailwind.git
$ cd django-soft-dashboard-tailwind

Step 2 - Start the APP in Docker

$ docker-compose up --build 

Visit http://localhost:5085 in your browser. The app should be up & running.


✨ How to use it

Download the code

$ git clone https://github.com/app-generator/django-soft-dashboard-tailwind.git
$ cd django-soft-dashboard-tailwind

πŸ‘‰ Set Up for Unix, MacOS

Install modules via VENV

$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt

Set Up Database

$ python manage.py makemigrations
$ python manage.py migrate

Start the app

$ python manage.py runserver

At this point, the app runs at http://127.0.0.1:8000/.


πŸ‘‰ Set Up for Windows

Install modules via VENV (windows)

$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt

Set Up Database

$ python manage.py makemigrations
$ python manage.py migrate

Start the app

$ python manage.py runserver

At this point, the app runs at http://127.0.0.1:8000/.


✨ Create Users

By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:

  • Start the app via flask run
  • Access the registration page and create a new user:
    • http://127.0.0.1:8000/register/
  • Access the sign in page and authenticate
    • http://127.0.0.1:8000/login/

✨ Code-base structure

The project is coded using a simple and intuitive structure presented below:

< 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/
   |    |-- includes/        # HTML chunks and components   
   |
   |-- static/
   |    |-- CSS, JS, Images  # CSS files, Javascripts files   |
   |-- requirements.txt      # Project Dependencies
   |
   |-- env.sample            # ENV Configuration (default values)
   |-- manage.py             # Start the app - Django default start script
   |
   |-- ************************************************************************

✨ Customize CSS

  • Edit the static/assets/scss/styles.css
  • Regenerate the CSS
$ npm i
$ npm run build


Soft Dashboard Tailwind Django - Free starter provided by AppSeed.

About

License:Other


Languages

Language:HTML 80.4%Language:CSS 10.5%Language:JavaScript 8.1%Language:Python 0.9%Language:Dockerfile 0.0%Language:Shell 0.0%