Servus

At your Servus

Description

Servus is an operation to connect customers with service providers. Customers are greeted with a list or map of services near them. Providers have public profiles with a menu of services offered and photo examples of past work. They also have a schedule for clients to book appointments.

Core Features

• Customers can browse services near them by using a list or map
• Customers can book appointments for services based on the server's availability
• Servers can provide a menu of the services they offer and their availability
• Servers can advertise their past work

Technologies

• Web ➤ React
• Backend ➤ NodeJS + Express
• Database ➤ MongoDB

Run Instructions

Please note, without the proper environment variables you will not be able to run the web application locally. This includes the acceptance tests. In order to get the proper environment variables, please contact Arvind.

Accessing the hosted web app

• Go to http://servus.pw. Your browser may try to cache it as https -- if the link does not work, try using an incognito or private browsing tab.
• If you'd like to run the website with an existing user, you can login to the website with username and password: arvind

Manually run the web application locally

1. Clone the repository.
2. Installation:
   • This requires node to be installed. https://nodejs.org/en/download/
   • Navigate to Servus/server/ in a command prompt and install with npm install.
   • Navigate to Servus/web/ in a command prompt and install with npm install.
3. Running the application:
   • From Servus/server/ in a command prompt, run npm start.
   • From Servus/web/ in a command prompt, run npm start.
     • This should open the app in your default browser. If not, navigate to localhost:3000 in your browser.

Running acceptance tests:

• Run the backend with the staging database: npm run acceptance from Servus/server/.
• Run the frontend: npm start from Servus/web/.
• Enter npm run cypress:open from Servus/web/ in a command prompt.
  • Click "Run 4 integration specs" to run all tests, or click each test to run them individually.

Documentation

Coding Style

• The coding style for the project can be found here.

Meetings Notes

• The meeting notes can be found here.

Diagrams

• Project structure diagrams can be found here.

Testing Plan

• The testing plan document can be found here.

Group Members & Roles

Please note, each member acted as the 'Group Leader'

Andy Tan

Arvind Maan

Caden Chabot

Risto Zimbakov