Skip to content

kami-z88/courier

Repository files navigation

Django Boilerplate

This is a simple Boilerplate for starting Django projects. It includes a user account app containing profile, account settings and profile editor pages. it's theme is based on Bootstrap v4 and includes JQuery and FontAwesome.

Installation

  1. Clone Repository.
  2. Install "sorl-thumbnail" for photo thumbnails and "django-widget-tweaks" for improving bootstrap integration with forms.
pip install git+git://github.com/mariocesar/sorl-thumbnail@v12.3
pip install django-widget-tweaks
  1. Migrate
python manage.py makemigrations account
python manage.py migrate
  1. Rename the "app" directory to your app's name and change it in INSTALLED_APPS.

Note: make sure that you are using latest version of Django. I've used Django 1.11 with Python 3.5 for this version.

Documentation

  • The directory "project" holds your project files, settings, global static files(bootstrap, jquery, ...).
  • The directory "app" holds a blank application. you can change directory's name and make the same change in settings file in INSTALLED_APPS.
  • The directory 'account' holds the app for user profile pages and it's specific templates and static files.
  • In app's directory create a directory named static to hold your JS,CSS, fonts and image files.
  • In app's directory create a directory named template for your template files.
  • you can extend based on "base.html" to have standard navigation or "base-clean-header.html" to have an empty template.
{% extends "base.html" %}
  • Edit "project/templates/base.html" to change navigation or general design of main container.

Configurations in Django Project's settings

  • Django modules "Sites" and "FlatPages" have been added.
  • the directory "project/templates" has been added to TEMPLATES contant.
  • STATICFILES_DIRS list holds the list of directories holding static content. you can add new static directories for each app to this list.
  • MEDIA_ROOT constant holds the general media directory for uploaded files.

Copyright

This project is published under [MIT License]. you are free to use or change it in any way you like.

Contrubutions

Feel free to fork the project and push improvements.

About Developer

This project is created by Towhid.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published