Hand-off Plan

The project code are tracked in a public GitHub repository and the next team will be able to clone the code. The team next semester can clone the code using git clone <repo url> and create their own repository, transferring ownership.

Our code works standalone on a computer. The client (or team next semester) can follow the hand-off video to set up the code and run it in an IDE. We also put the same instructions in the following sections and README.md on GitHub.

In it’s current state, the application is not running on any remote servers, so the frontend server, backend server, and database server run on different ports on localhost.

In order to run and maintain the application and API, MongoDB, Express.js, Angular, Node.js, Mongoose, and Survey.js are necessary. Visual Studio Code is recommended as the IDE.

Administrator Documentation

Clone Code from GitHub Repo:

  • Go to the GitHub repository
  • Go to Code > HTTPS > Copy url to clipboard
  • Open a command line tool, go to the directory you want to place the project in, run git clone <repo url>

Installation:

To install MongoDB & MongoDB Compass (follow links below for required software downloads):

MongoDB Installation

MongoDB Compass (Local testing and a GUI application)

To install other tools and libraries:

  • Express.js, Angular, Mongoose, Survey.js are all node libraries and can be installed by running the npm install <node library> command in command line. For more information on npm click here.
  • The convenient way to install all libraries and dependencies is to run npm install in both the api and my-app folder.

Set up local MongoDB server and use GUI software like MongoDB Compass:

  • Open command line tool, and run brew services start mongodb-community@7.0 to start the local database server.
  • Open the MongoDB Compass application.
  • Type in your URI in the New Connection box (mongodb://localhost:27017 for a local testing server) and Connect.
  • To stop the local database server, run brew services stop mongodb-community@7.0 in command line.

Set up Backend

  1. Go to your local repo
  2. Run cd api
  3. (You only need to do this step once) Create .env file and paste EMAIL_PASSWORD=##### EMAIL_USERNAME=##### where the password is you Google account app password and username is your Google account email address.
  4. Run npx tsx app/src.ts

Set up Frontend

  1. Go to your local repo
  2. Run cd my-app
  3. Run ng serve

Hand-off Video

Video on instructions of how to set up the environment and start the web app: