Home

Welcome to SOS Django Template documentation. This documentation will give you information as to how to install, configure and utilize SOS Django Template.

What is SOS Django Template?

SOS Django Template is a Django starter template that has opinionated and good solutions while starting your new Django project.

Django is a batteries-included backend framework. While it comes with a good starting template, this boilerplate is not usually enough for developing your projects further. So, you will often find yourself installing 3rd party packages, configuring them and structuring your project according to these 3rd party solutions, which is a waste of time. Instead, SOS Django Template starts you from opinionated but sensible defaults.

Why use it?

• Django provides a single settings file and you are expected to separate the development and production environment. Hence the name (SOS a.k.a. Separation of Settings), this template already separates them for you beforehand. Furthermore, this template contains .env file to integrate your project with any production environment with less hassle.
• Testing is an important part of development. While Django provides its own built-in solution, we have better alternatives in terms of performance, development time cost and ease of use today. SOS Django Template provides you these solutions.
• This template comes with a good dependency solution while standard Django template does not have any stance on what to use and you are expected to setup and configure it.
• This template is built with AJAX and RESTful services in mind.
• This template already assumes you will want to have asynchronous operations in your app and sets it up for you.
• Creating a custom user is best done in the beginning of development, or else you will have a lot of database migration problems. This template exposes a custom CoreUser model for you to add fields to.
• This template assumes you will use PostgreSQL as your database and comes with its configurations. If you use another, don't worry, you can edit your .env file to use another database driver quite easily.
• This template thinks about you editor too and comes with VSCode settings and editorconfig.

Should I, though?

At this point, I can tell that SOS Django Template project is a MVP. You can test it out in your own environment and build projects with it. Stability will be achieved by you providing feedback to project.