Giter Club home page Giter Club logo

django-template's Introduction

The ultimate Django template to build a startup

Lets be clear. If you can do a task in less than 5 minutes why would you even bother in do all this hard work by yourself? This cookie cutter provides you with:

  1. Django base project: The wizzard will create a default Django project structure
  2. CI/CD integration with Github actions: Github actions will be already configured in your project. It will deploy to your production server everytime a new commit is pushed to the master branch.
  3. Docker: you will get Docker support out of the box. You will get a production ready Docker environment and also a local development environment to add new features to your project.
  4. Docker environment files: The template will automatically the environment files that contains all the sensetive data. This files will not be reposited in your project to prevent password leaks.
  5. HTTPS out of the box: When using the template wizard, you must use the real production domain for your project. This will be used to create the certificates of your production domain. The certificates will be automatically renewed.
  6. Monitoring: If selected in the wizard, Sentry configuration will be added to your project. Remember to edit the Sentry DSN once you created your project in order to connect your project with your Sentry account.
  7. Metrics: If selected in the wizard, Grafana and Prometheus will be added to your project. This template will configure the datasource automatically and will add a dashboard to your Grafana displaying basic metrics of your Django application.

Architecture Diagram

Once all the tools are installed, you architecture would look like the following

Arhitecture Diagram

Things to take in consideration

  • The .envs generated by the template will be in the .gitignore. Those files will be generated but will not be reposited. When you install the app in the server, make sure that you copy the .env files.

  • In order to make Letsencrypt generate the certificates it will use a HTTP-01 challenge. In order to configure the pro environment, make sure that the domain configured in the cookicuter is properly configured in the DNS side. You must add A and AAA records in order to make letsencrypt work. If you want to learn more of the challenges that Letsencrypt does, follow this guide.

Usage of the django-template

To execute the cookiecutter template wizard run:

$ pip install cookiecutter
$ cookiecutter gh:adriancast/django-template

If you need more information about cookiecutter visit this oficial guide.

Screenshot from 2021-07-11 13-09-40

django-template's People

Contributors

adriancast avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.