New Developer Guide

Welcome to the backend team for MYR! Below is (hopefully) everything you need to get started.

About the backend

MYR is built using the MERN stack. MERN stands for Mongo, Express, React, and Node. We use Mongoose as an ODM to interact with the database.

MYR is hosted on a virtual machine at UML. Read more information about the server in the sidebar.

Getting started

Prerequisites:

• Installation of MYR
• (Optional) Installation of MYR admin portal

Install Docker

• MYR backend uses a docker container to run the application
• You can install desktop application (Recommended) or docker engine and docker-compose
  • If you are on windows, you have to enable WSL2 for docker desktop

Steps

1. Fork backend repository from Engaging-Computing page.
2. Navigate to the parent directory of where your MYR development environment is.
3. Clone the repository by running these commands
   1. Make sure to clone them onto same parent directory as your frontend and/or admin.

    git clone https://github.com/[your-username]/myr-backend.git
    cd MYR-backend
    git remote add upstream https://github.com/engaging-computing/MYR-backend.git

Create Following folders inside the repository

1. Use nvm v12.18.2
2. After nvm is install you should able to run command npm on CLI.
3. Run npm install within the MYR backend to install the dependencies.
4. Make a copy of .env.example and rename it to .env.
5. Update .env to include your OAuth2 key.
6. You can start running the backend by running docker-compose up
7. You can close or exit the backend anytime with Ctrl + C
8. Start developing!