Project Setup Guide

Prerequisites

• Python 3.12.8
• Node.js and npm
• Git

Installation Steps

1. Clone the Repository

git clone <repository-url> cd <project-directory>

2. Set up Python Environment

# Create and activate virtual environment
python -m venv .venv source .venv/bin/activate # On Windows use: .venv\Scripts\activate
# Install Poetry
pip install poetry
# Install Python dependencies
poetry install

3. Configure Environment Variables

# Copy the environment template
cp .env.template .env
# Edit .env file with your settings
# Make sure to update:
# - SECRET_KEY
# - DATABASE_URL
# - Other required environment variables

4. Install Node.js Dependencies

# Install required npm packages
npm install

5. Database Setup

# Apply migrations
python src/manage.py migrate
# Create a superuser
python src/manage.py createsuperuser

6. Static Files

# Collect static files
python src/manage.py collectstatic

7. Start Celery Worker (in a separate terminal)

# Start Celery worker
./celery.sh

8. Run Development Server

# Start the Django development server
python src/manage.py runserver

Running Tests

# Run tests
./run_tests.sh

Additional Configuration

Media Files

Create required media directories:

mkdir -p src/apps/media/rombus_outputs

Development Tools

For development, you might want to install additional tools:

Install development dependencies

poetry install --with dev

Troubleshooting

1. If you encounter permission issues with media directories, ensure proper permissions are set
2. Make sure all services (database, Redis if used) are running
3. Check the .env file has all required variables set

Project Structure

• src/ - Main project directory
  • apps/ - Django applications
  • config/ - Project configuration
  • rombus_models/ - Rombus-specific models
  • templates/ - HTML templates
  • static/ - Static files

Available Scripts

• Starts the Celery worker celery.sh
• Django management commands manage.py