# Repository Structure

HIPPO Gym is broken down into 4 parts:

  1. The main program: HIPPO_Gym (opens new window) is required by each individual researcher for setting up and deploying a research project.

  2. The AWS code: HIPPO_Gym_AWS (opens new window) contains the AWS Lambda functions and instructions required to setup the HIPPO Gym Infrastructure.

  3. The ReactJS Front End: HIPPO_Gym_FrontEnd_React (opens new window) contains the UI currently deployed at irll.net (opens new window).

  4. The Docs: HIPPO_Gym_Docs (opens new window) contains the code for this website.

# Versioning

We will strive to maintain semantic versioning compatible with the standards found at semver.org/ (opens new window)

In short X.Y.Z where

X = Non-backwards compatible major release

Y = backwards compatible feature release

Z = backwards compatible bug fixes

We will also maintain major version compatible front-ends at irll.net/vX that