Step-by-step guide to install DripEmails.org on your system.

1. Clone the Repository

git clone https://github.com/dripemails/web.git
cd web

2. Set Up Python Environment

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

python -m venv venv
venv\Scripts\activate
pip install -r requirements.txt

3. Configure Environment

Create a .env file with your configuration:

cp docs/env.example .env

Edit .env with your settings (see Configuration Guide)

4. Run Migrations

python manage.py migrate

5. Create Superuser

python manage.py createsuperuser

Follow the prompts to create your admin account.

6. Collect Static Files (Production Only)

python manage.py collectstatic

7. Start the Development Server

python manage.py runserver

8. Set Up AI Features (Optional)

To enable AI-powered email generation:

$env:HUGGINGFACE_API_KEY = "hf_your_token_here"

export HUGGINGFACE_API_KEY="hf_your_token_here"

HUGGINGFACE_API_KEY=hf_your_token_here

9. Start SMTP Server (Optional)

For local email testing:

# Basic local development (default port 1025)
python manage.py run_smtp_server

# Custom port
python manage.py run_smtp_server --port 2525

# With debug mode
python manage.py run_smtp_server --debug

Verification Steps

python manage.py shell

>>> from django.core.mail import send_mail
>>> send_mail('Test', 'Test message', 'from@example.com', ['to@example.com'])

Common Installation Issues

# Linux/macOS
source venv/bin/activate

# Windows
venv\Scripts\activate