Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.53 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.53 KB

Background

Overview

Django Rockstarter is a Python package designed to accelerate the setup of Django projects by automatically creating a robust, production-ready directory structure and essential configuration files. With built-in support for django-environ to manage environment variables securely and whitenoise to handle static files efficiently, Rockstarter ensures your Django projects are well-prepared for deployment.

Key Features

  • Production-Ready Structure: Automatically sets up a comprehensive directory structure tailored for Django projects, adhering to best practices.
  • Secure Configuration: Integrates django-environ to simplify the management and encryption of environment variables.
  • Static Files Handling: Utilizes whitenoise to serve static files directly from your application, enhancing performance and security.
  • Time-Saving: Eliminates the repetitive task of manually setting up project directories and configuration, allowing you to focus on writing code.

Setup

  1. Install django rockstarter package
pip install rockstarter
  1. Init project
rockstarter run
  1. Move environ sample
mv .env.sample .env

if necessary, edit .env and add your domain in ALLOWED_HOSTS

  1. Migrate
python manage.py migrate

Local Running

Running Server (local)

python manage.py runserver

Production

  • Live to production
rockstarter deploy my.domain.com
  • Drop website
rockstarter drop my.domain.com