Setting up a development environment

First, you will need to install the following:

  • python

  • pipenv

  • git

You will also need a Github account.

First, fork tin. Then you can clone tin onto your computer with

git clone https://github.com/YOUR_GITHUB_USERNAME/tin

After that, install dependencies and follow standard django procedures

Note

If you’re on windows and get errors about python3 not existing, try using python instead of python3.

pipenv install --dev
python3 manage.py migrate
python3 create_debug_users.py

Now you’re all set! Try running the development server

python3 manage.py runserver

Head on over to http://127.0.0.1:8000, and login as admin and the password you just entered.

NixOS Setup

A flake.nix file is provided for NixOS users. To use it, first enable the redis service globally. Place the following in your /etc/nixos/configuration.nix:

services.redis.server."".enable = true

This will start a systemd service called redis. After that, you can start the flake with:

nix develop

You can then install dependencies, setup the database, and run the development server as described above.

Tip

You may also need to set nix.settings.experimental-features = ["nix-command" "flakes"]; in your configuration.nix.