Official repository of rebutify.org
Status page

Table of Content

• Table of Content
• 1. Installation
  • 1.1 Environment Variables
  • 1.2. Docker
  • 1.3. Python
    • Unix OS
    • Windows OS
• 2. Deployment
• 3. Contributing

1. Installation

1.1 Environment Variables

Create a .env file at the root of the project based on .template-env's content.

cp .env-template .env

⚠️ Put your DJANGO_SECRET_KEY in your .env file.
If you don't have a secret key for your project, generate a secure password longer than 50 characters.

1.2. Docker

Start the docker container:

docker compose up

1.3. Python

Install the dependencies in a new virtual environment from the root directory /rebutify.

python -m venv .venv

---

Unix OS

source .venv/bin/activate

Windows OS

source .venv/Scripts/activate

---

pip install -r requirements.txt

2. Deployment

Begin serving the application with gunicorn.

gunicorn --bind 0.0.0.0:8000 -k uvicorn.workers.UvicornWorker rebutify.asgi:application

3. Contributing

For instructions on contributing, read CONTRIBUTING.md.