Upvent

Repository for final year project.

This project is hosted on Heroku and is available at https://upvent-app.herokuapp.com.

Prerequisites:

To run the source code locally, Node.js is required (the latest version should work).

Then, clone the project’s GitHub repository.

As the project uses MongoDB Atlas as its database, you are required to create a collection, or alternatively run a local version of MongoDB. Either way, create a new collection and record the connection string, which will be in the format:

mongodb://[username:password@host1[:port1][…hostN[:portN]]/[defaultauthdb][?options]]

for a MongoDB Altas connection, or:

mongodb://username:password@localhost

for a local database.

Initialising the Project:

Navigate to the root of the project in a terminal and run the command **npm install** (or **npm i**) to install dependencies.

Then, run the command cd client to go to the client folder and run npm install again.

Finally, return to the root directory by running 'cd ..'.

Running the Project:

Execute the command npm run dev to concurrently launch both the client and server. Upvent should open automatically in your default browser, but if it doesn’t head to localhost:3000 in your browser.

When the project is running successfully, the terminal should look something like this:

To run the tests locally, run npm test (also from the root directory).

Creating a Production Build:

Run the command npm build to create an optimised production build. The build can be found in /client/build.