Skip to content

kbarnes3/BaseDjangoSite

Repository files navigation

BaseDjangoSite

A basic template for a Django site and the framework to deploy it.

This project is intended to be copied and pasted into an empty repo as the basis of a new Django site. From there, developers are encouraged to modify and delete code to suit their needs. This project is intended to be comfortable to use for someone familiar with Django (or at least someone who has completed a Django tutorial project). As such, it tries to stay as close to a vanilla Django project as possible.

To get an idea of the intended developer work flows for projects based on this template, read Setup-Dev-Environment.md and Setup-Server-Environment.md.

Using BaseDjangoSite as your project template

To start a new Django site based on this project, do the following steps

  1. Create an empty Git repo and copy the contents of this repo into it. Alternatively, clone this repo to a new directory and then delete the .git folder.
  2. Remove or update the following files to reflect your project: README.md and LICENSE.TXT
  3. Ensure the latest release of Python 3.6 is installed on your computer
  4. Run the "replacer.py" script to personalize the BaseDjangoSite template files. The script should be run with: py -3.6 replacer.py
  5. The script will prompt you for values such as your project domain, URL, and email address. The script will then edit and rename files based on the provided values.
  6. Delete the replace.py file
  7. Commit all the remaining files to Git.
  8. From PowerShell, run scripts\Bootstrap.ps1 -Verbose followed by scripts\Ensure-Venv.ps1
  9. Run python secret_key.py and copy the output into the SECRET_KEY property in web\$project_name$\settings_base.py. Be sure to uncomment the property.
  10. Follow the instructions in Setup-Dev-Environment.md to set up a local development environment.
  11. Follow the instructions in Setup-Server-Environment.md to set up a server deployment.

About

A basic template for a Django site and the framework to deploy it.

Resources

License

Stars

Watchers

Forks

Packages

No packages published