Metadata-Version: 2.1
Name: rockstarter
Version: 0.1.7
Summary: A simple tool to create django-ready project
Home-page: https://github.com/koderstory/rockstarter
Author: Koderstory
Author-email: hello@koderstory.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django>=4.2.15
Requires-Dist: asgiref==3.8.1
Requires-Dist: django-environ==0.11.2
Requires-Dist: sqlparse==0.5.1
Requires-Dist: whitenoise==6.7.0
Requires-Dist: gunicorn==23.0.0
Requires-Dist: psycopg2==2.9.9

# 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
```

2. **Init project**
```
rockstarter run
```

3. **Move environ sample**

```
mv .env.sample .env
```
if necessary, edit .env and add your domain in **ALLOWED_HOSTS**

4. **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
```




