Hand-Off Plan

The project code is hosted in a public GitHub Repository, making it accessible for the next team. The upcoming team can clone the repository using the command: `git clone <repository_url>`.

Once cloned, they should create their own repository to manage and take ownership of future development.

The application is currently designed to run standalone on a local computer. The next team (or client) can refer to the hand-off video, which will be uploaded soon for detailed setup instructions. These instructions are also documented in the following sections and the README.md file within the repository.

In its current state, the application does not utilize any remote servers (Potential Future scope for this semester if time permits). Instead, the following components run locally on separate ports:

Frontend server
Backend server
Database server

Administrator Documentation

Clone the Code from GitHub Repository

Navigate to the GitHub repository.
Select Code > HTTPS and copy the repository URL to your clipboard.
Open a command-line tool and navigate to the directory where you want to place the project.
Clone the repository by running the following command: `git clone <repository_url>`

Installation

Install MongoDB and MongoDB Compass

Follow the links below to download and install the necessary software:
- MongoDB Installation
- MongoDB Compass (for GUI-based local database testing)

Install Node Libraries and Dependencies

Install required node libraries such as Express.js, Angular, Mongoose, and Survey.js by running: `npm install <library_name>`

For more details, visit npm documentation.
To conveniently install all required libraries and dependencies:
- Navigate to the api folder and run: `npm install`
- Navigate to the my-app folder and run: `npm install`

Set Up Local MongoDB Server

Open a command-line tool and start the local database server by running: `brew services start mongodb-community@7.0`
Launch the MongoDB Compass application:
- In the New Connection box, enter the URI: mongodb://localhost:27017 (for the local testing server).
- Click Connect.
To stop the local database server, use the command: `brew services stop mongodb-community@7.0`

Requirements
To run and maintain the application, the following technologies are required:

MongoDB
Express.js
Angular
Node.js
Mongoose
Survey.js

Recommended Development Environment

IDE: Visual Studio Code is recommended for its features and compatibility.

Set up Backend:

(You only need to do this step once. This is for setting up the email account to send verification emails for this app.)

Create a .env file in the api folder, with content:

EMAIL_USERNAME=#####

EMAIL_PASSWORD=#####

, where username is your Gmail address, and password is your Google account app password.

Go to the command line of the local repository
Run `cd api`
Run `npx tsx app/src.ts`

Set up Frontend

Go to the command line of the local repository
Run `cd my-app`
Run `ng serve`

My Movie 5.mp4

Page updated

Google Sites

Report abuse