Development Environment Quickstart

Backend Set-Up Using Docker

Step 1: Fetch Backend Code

git clone https://github.com/benetech/MathShareBackend.git

Step 2: Install docker if you haven't already

Docker Install Page

Step 3: Navigate to MathShareBackend directory. Fetch and run image with docker compose

docker-compose -f docker-compose.pre_built.yml up

Step 4: If a new version of Backend is required, run the following three commands

docker-compose -f docker-compose.pre_built.yml down

docker-compose -f docker-compose.pre_built.yml pull

docker-compose -f docker-compose.pre_built.yml up

Running the frontend

Step 1: Fetch frontend code

git clone https://github.com/benetech/MathShare.git

Step 2: Navigate to MathShare directory, and install dependencies

npm install

Step 3: Start Frontend

npm start

Note: This will open a browser window to the localhost immediately, but the app will take 1-2m before it is started.