/trainee-1-2-23t2

Primary LanguageTypeScript

Good Shit

Contributors Commit Activity GitHub Repo size

Good Shit is an interactive toilet finder designed to help UNSW students plan and find their ideal bathroom breaks.

Running Good Shit Locally

Prerequisites Before you start, make sure that you have the following software installed.

  • Git (standard on Linux) or GitHub Desktop
  • Node.js and npm (usually bundled with Node.js)

Setup

Clone the repository:

$ git clone git@github.com:csesoc/trainee-1-2-23t2.git

Download Dependencies

From the root of the repository run the following command to download dependencies:

$ cd backend && npm i && cd ../frontend && npm i && cd ..

NPM install in both the backend and frontend directories.

Running the Front-end

To run the frontend run navigate to the /frontend directory and run npm run dev - i.e.

$ cd frontend && npm run dev

from root or

$ npm run dev

from the /frontend directory.

Running the Back-end

Run to run the backend:

  1. Navigate to the /backend directory:
$ cd backend
  1. Create a .env file in the root of the project containing:
MONGO_URI = [YOUR_MONGO_URI];
JWT_SECRET = [YOUR_JWT_SECRET];
  1. To start the server, run:
$ npm start