Official Deerhunt Infrastructure

This is the official repo of the Deerhunt Website developed and run by the UTM Robotics Club. This is an open source project maintained by our students.

The Deerhunt Infrastructure project is a full stack application built for the purpose of hosting and running AI competitions.

For more on the project structure, check out the use-case diagram and storyboard.

Folder Structure

.
├── deerhunt/
│   ├── package.json
│   ├── package-lock.json
│   ├── public/
│   ├── README.md
│   └── src/
├── tests/
│   ├── ref
│   └── test_auth.py
├── server/
│   ├── app.py
│   └── requirements.txt
├── install.sh
└── README.md

deerhunt/: Everything to do with the frontend lives here. You will find npm related files here as well as the frontend source files.

server/: All backend source files live in this folder.

tests/: All unittests at least for the backend will live here. Currently empty but will be populated soon. Make sure you are familiar with Pytest Framework.

Dependencies

A unix based computer
git
python3+
npm

Development Setup Instructions

I encourage you to go through the install script to understand what it is doing before running it. Once it runs you should have a folder called venv/ created. After running the install script you have to source your venv folder and your terminal should look something like this:

$ (venv) adl@Cronos ~/git/deerhunt2020/infrastructure

If you need to read up on python virtual environments you can do so here.

Ubuntu / Debian

It is important that you have a Linux installation such as Ubuntu / Debian which uses apt as its package manager since the script uses it. Also make sure you keep your system packages up to date.

$ sudo apt update
$ sudo apt upgrade -y
$ cd Deerhunt-Infrastructure
$ ./install.sh
$ source venv/bin/activate

Mac OSX

Make sure you have Homebrew installed and updated before running the script below.

$ brew update
$ brew doctor
$ cd Deerhunt-Infrastructure
$ ./install.sh
$ source venv/bin/activate

Windows (2 methods)

There are two options for windows users to run the environment

WSL (Recommended)
SSH/Remote

WSL (Windows Subsystem for Linux)

What is WSL 2:

https://docs.microsoft.com/en-us/windows/wsl/about

Enable WSL 2:

https://docs.microsoft.com/en-us/windows/wsl/install-win10

Using WSL 2, users should be able to open a Linux Shell in linux, and follow the steps from "Ubuntu/Debian".

Ubuntu SSH at Deerfield Hall - Not recommended

It is highly recommended to setup your development environment on a unix environment. If you are on Windows and don't have access to a local Ubuntu / Debian computer, you can ssh into the UTM Deerfield CS lab which hosts Ubuntu by doing the following:

$ ssh <UTORid>@dh<XXXX>pc<YY>.utm.utoronto.ca
Where:
<UTORid> is your UofT acorn username.
<XXXX> is CS Lab number (eg: 2020 or 2026).
<YY> is the computer number in the lab.

Example:
$ ssh linalex7@dh2026pc01.utm.utoronto.ca

Running Tests

Read about testing here.

Contributing

Pull requests are welcomed. Check out our Deerhunt Infrastructure Trello board for outlined changes that the team is looking to work on.

A timeline for project tasks is outlined here.

Production

To be completed when infrastructure is ready for production.

Confused?

Here's a link to our documentation

utmrobotics/Deerhunt-Infrastructure