Skip to content

Latest commit

 

History

History
190 lines (132 loc) · 4.56 KB

README.md

File metadata and controls

190 lines (132 loc) · 4.56 KB

Soft Tailwind Django PRO

Premium Django Dashboard provided by AppSeed on 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 web apps.

Soft UI Dashboard is built with over 100+ frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining - Designed by Creative-Tim.


Features

  • ✅ Design: Soft Dashboard by Creative-Tim
  • ✅ Styling: Tailwind CSS
  • ✅ Up-to-date dependencies
  • ✅ Session-Based authentication, Forms validation
  • ✅ Admin Section Styled (reserved for superusers)
  • ✅ Docker
  • 🚀 CI/CD flow via Render

Soft Dashboard Tailwind PRO - Premium Django starter crafted by AppSeed and Creative-Tim.


Start with Docker

Step 1 - Download the code from the official product page (requires a purchase)

$ unzip django-soft-dashboard-tailwind-pro.zip
$ cd django-soft-dashboard-tailwind-pro

Step 2 - Start the APP in Docker

$ docker-compose up --build

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


Manual Build

Step 1 - Download the code from the official product page (requires a purchase)

$ unzip django-soft-dashboard-tailwind-pro.zip
$ cd django-soft-dashboard-tailwind-pro

👉 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

Create Superuser

$ python manage.py createsuperuser

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

Create Superuser

$ python manage.py createsuperuser

Start the app

$ 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:

< 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 using NPM or Yarn
$ npm i            # Install modules
$ npm run build    # Recompile SCSS to CSS
$ npm run min-css  # Minify CSS
$ // OR 
$ yarn             # (via Yarn) Install modules
$ yarn build       # (via Yarn) Recompile SCSS to CSS
$ yarn min-css     # (via Yarn) Minify CSS

Soft Tailwind Django PRO - Free starter provided by AppSeed.