Setting up a development environment¶

To begin with, you will need to have git installed on your computer. 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

From here, you can either use a local setup, or use Docker. Check out the relevant sections.

Docker¶

If you prefer, you can run the development setup with Docker. To do so, cd into the project directory and run:

.. code-block:: bash

docker compose build docker compose up

To create testing users and apply migrations, run the below command in a separate terminal:

.. code-block:: bash

./scripts/docker_setup.sh

Local Setup¶

To set up your environment locally, you will need to install the following:

python (3.11)
pipenv

Then, run these commands:

.. code-block:: bash

pipenv install –dev pipenv run python3 manage.py migrate pipenv run python3 manage.py create_debug_users

Note

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

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

pipenv run python3 manage.py runserver

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

In order to actually submit code, there are some more steps. First, you’ll need to install redis.

You’ll also need to start the celery worker. This can be done by running the following command in a separate terminal:

pipenv run celery -A tin worker --loglevel=info

Final Steps¶

After that, you’ll want to create a course and an assignment in the course. After saving the assignment, you can hit “Upload grader” to add a grader - the simplest example of a grader is located in scripts/sample_grader.py.

Now you can try making a submission, and as long as your submission doesn’t throw an error you should get a 100%! Congrats on your brand new 5.0 GPA!