JellyBean Project

A Django-based forum/board application.

Prerequisites

• Docker

Getting Started

1. Environment Setup

Copy the example environment file and fill in your actual secrets:

cp .env.example .env

Open .env and configure your credentials (SECRET_KEY, Database, Social Auth, etc.).

2. Build and Run

Launch the application using Docker Compose:

docker-compose up --build

The application will be available at http://localhost:8000.

3. Database Initialization

Once the containers are running, apply the database migrations:

docker-compose exec web python manage.py migrate

4. Create a Superuser (Optional)

To access the Django admin interface (/admin), create a superuser account:

docker-compose exec web python manage.py createsuperuser

Useful Commands

• Stop the application: docker compose down
• Restart from scratch (clears environment): docker compose down && docker compose up --build
• View logs: docker compose logs -f web
• Run tests: docker compose exec web python manage.py test
• Collect static files: docker compose exec web python manage.py collectstatic

Troubleshooting

• Database Errors: If the database fails to initialize, ensure DB_PASSWORD is set in your .env file and run docker compose down before starting again.
• Dependency Issues: If you add new packages to requirements.txt, run docker compose up --build to rebuild the image.

Security Notes

• This project uses python-decouple for configuration. Never commit your .env file to version control.
• In production, ensure DEBUG=False in your environment variables.