D4. User Manual

User Documentation

The UNC department of psychiatry will be the user for this application. They will be entering team data and client data into the forms to create a database with data from the psychiatry organizations of multiple counties from across the state.

As a user, their job will be to:

  • Input data about the team that they want to add to the data base
  • Input contact information for the team

This will allow the UNC psychiatry team to have a point of reference to use as they work with the team.

Before using the application, the user should ensure that all of the information to be entered into the survey is collected. This includes team name, organization phone number, email, and patient information. The data will be inputted into the database once the survey is filled out and submitted.

Administrator Documentation

As stated above, for the final documentation, a Google Document with a table of contents section will be the most beneficial. We can include a step by step description of how to install and use the application as an administrator. *Since this is a legacy project, most of the documentation seen below is repeated from last semester*

In order to run and maintain the application and API, MongoDB, Express.js, Angular, Node.js, Mongoose, and Survey.js is necessary. For API testing, Insomnia is beneficial. Visual Studio Code is recommended as the IDE (although any works) and GitHub desktop is beneficial for easy code repository management.

How to install (follow links below for required software downloads):

MongoDB (Sign in here)

MongoDB Compass (Local testing and a GUI application)

To use software like MongoDB Compass:

  • Open the MongoDB Compass application.
  • Type in your URI in the New Connection box (mongodb://localhost:27017 for a local testing server) and Connect.
Insomnia

Visual Studio Code

GitHub Desktop

Once you have all the above software installed you can clone the code repository from GitHub into whatever environment you choose. Our suggestion is using GitHub Desktop to open the code file in Visual Studio Code.

Once you have your code opened open a new terminal in VSCode. Terminal > New Terminal.


In your terminal follow the Node instructions below.

Node.js
  • Express.js, Angular, Mongoose, Survey.js are all node libraries and can be installed using the npm install command in a terminal or command prompt.
  • Run npm install <node library> for all of the above libraries in a terminal or command prompt while you are in the folder for the code library. For more information on npm click here.

System Capabilities:

  • Ability to open and fill out 5 unique surveys and store it into a MongoDB database through a RESTful API process.
  • Ability to retrieve said data from the MongoDB database and display it to the user.

System Incapabilities:

  • Log-in system for the user.