Sloppy Labwork

Setup

Docker

You want to work with Docker? Nice! You can skip all the Python setup steps below. We just have to make sure our local configuration files get created. Git ignores this file (it contains secrets), but we do keep a handy template around that will get you off the ground:

cp ./sloppy_labwork/local_environment.py-example ./sloppy_labwork/local_environment.py

Local Development with uv

We use uv for package and environment management. The Python version is specified in .python-version.

1. Install uv if you haven't already:

   # macOS/Linux
   curl -LsSf https://astral.sh/uv/install.sh | sh
   
   # Windows
   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
   

2. Sync dependencies (this creates the virtual environment automatically):

   uv sync
   

3. Copy the local environment template:

   cp ./sloppy_labwork/local_environment.py-example ./sloppy_labwork/local_environment.py
   

You may update this local environment file to turn features on/off and update app secrets.

Run It

Docker

Start the app with:

docker-compose up

And you should be good to go!

Note that the first time you run the app, as well as any time you wish to apply database migrations, you'll have to do so with the following command:

docker-compose exec web python manage.py migrate

Local Development

Once setup is complete, you can apply database migrations with:

uv run python manage.py migrate

And run the development server with:

uv run python manage.py runserver

Signing In

In production, we only support signing in via 3rd party authentication providers. The most convenient way to authenticate during development is by using the Django Admin at http://localhost:8000/admin.

Alternatively, you may enter a SocialApp record in the DB for your own Discord app.