MunHelper - Frontend

This repository contains the Frontend code for MunHelper.

Prerequisites

• Make sure Node is installed
• You need to have an instance of MUNHelper running. You will need to configure the Backend Host and Port on the website settings.

Build Instructions - Docker

• To build MUNHelper, follow the instructions in this repo.
• Configure the .env file as previously described.
• Once configured, build and run the frontend container like so.

docker build -t mahasvan/munhelper-frontend:latest .

To run the built container:

docker run -p 3000:3000 --name MunHelperFrontend mahasvan/munhelper-frontend:latest

Changing the port the app listens on

• Change the -p 3000:3000 part of the command like so.
• If you want the app to listen on port 8888, change it to -p 8888:3000
• This maps port 3000 inside the container, to port 8888 in the host machine.
• DO NOT change the 3000 after the :.

Build Instructions - Bare Metal

Warning

Use this method only if you have to. It is recommended to use Docker to host the app.

• Run the below command to build the frontend.

npm i
npm run build

This command builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

Deploying the app

npm install -g serve
serve -s build -l 3000

Change 3000 to the port you wish for it to listen at.

Building for Development

• Make sure you have Node installed.
• Use the following commands to make code changes and test without containerization.

  git clone https://github.com/Mahasvan/munhelper-frontend
  cd munhelper-frontend
  npm i
  npm start

• The app is now listening at http://localhost:3000
• To change the port that the app listens on, change the PORT variable in the .env file at the project root directory.