Skip to content

app-generator/django-argon-design-system-pro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

Seed project generated by AppSeed in Flask Framework on top of Argon Design System PRO with database, authentication, helpers and Docker support. Argon Design System PRO is built with over 1100 individual elements, 43 sections and 17 example pages giving you the freedom of choosing and combining.


Features

  • Up-to-date dependencies
  • Database: sqlite
  • UI-Ready app, Django Native ORM
  • Authentication
    • Session-Based authentication

Argon Design PRO - Seed project crafted by AppSeed.


✨ Start the app in Docker

Step 1 - Download the code and unzip the sources (requires a purchase).

$ # Get the code
$ unzip django-argon-design-system-pro.zip
$ cd django-argon-design-system-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.


✨ How to use it

Download the code and unzip the sources (requires a purchase).

$ # Get the code
$ unzip django-argon-design-system-pro.zip
$ cd django-argon-design-system-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
// OR with https
$ python manage.py runsslserver 

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
// OR with https
$ python manage.py runsslserver 

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/

Recompile SCSS

Navigate to apps/static/assets and execute the gulp command default task in the directory.

Compilation tests were made with:

  • Node v16.15.0
  • Gulp v4.0.2, CLI version 4.0.2
$ cd apps/static/assets
$ yarn                   # install modules
$ gulp                   # recompile SCSS

✨ Code-base structure

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

< PROJECT ROOT >
   |
   |-- core/                               # Implements app configuration
   |    |-- settings.py                    # Defines Global Settings
   |    |-- wsgi.py                        # Start the app in production
   |    |-- urls.py                        # Define URLs served by all apps/nodes
   |
   |-- apps/
   |    |
   |    |-- home/                          # A simple app that serve HTML files
   |    |    |-- views.py                  # Serve HTML pages for authenticated users
   |    |    |-- urls.py                   # Define some super simple routes  
   |    |
   |    |-- authentication/                # Handles auth routes (login and register)
   |    |    |-- urls.py                   # Define authentication routes  
   |    |    |-- views.py                  # Handles login and registration  
   |    |    |-- forms.py                  # Define auth forms (login and register) 
   |    |
   |    |-- static/
   |    |    |-- <css, JS, images>         # CSS files, Javascripts files
   |    |
   |    |-- templates/                     # Templates used to render pages
   |         |-- includes/                 # HTML chunks and components
   |         |    |-- navigation.html      # Top menu component
   |         |    |-- sidebar.html         # Sidebar component
   |         |    |-- footer.html          # App Footer
   |         |    |-- scripts.html         # Scripts common to all pages
   |         |
   |         |-- layouts/                   # Master pages
   |         |    |-- base.html             # Used by common pages
   |         |
   |         |-- accounts/                  # Authentication pages
   |         |    |-- login.html            # Login page
   |         |    |-- register.html         # Register page
   |         |
   |         |-- home/                      # UI Kit Pages
   |              |-- index.html            # Index page
   |              |-- page-404.html         # 404 page
   |              |-- *.html                # All other pages
   |
   |-- requirements.txt                     # Development modules - SQLite storage
   |
   |-- .env                                 # Inject Configuration via Environment
   |-- manage.py                            # Start the app - Django default start script
   |
   |-- ************************************************************************


Django Argon System PRO - Seed project generated by AppSeed Generator.

About

Argon Design System PRO - Premium Django Starter | AppSeed

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published