GoHere App

Description

A mobile app developed for people with Inflammatory Bowel Diseases for the purpose of helping them easily locate nearby washrooms.

Tools Used

Setup

Clone the repository by running the command in your terminal:

git clone https://github.com/Jyarn/c01w24-project-ByteBand.git

Install packages

Navigate to the project root and go to the backend directory. Install the required packages by running:

npm install

Once done, navigate back to the project root and go to the frontend directory. Install the required packages by running:

npm install

Configure constants

The app requires certain constants in order to run. Of these, the most important is the server URL, which contains its host and port.

To configure the default server URL, run the command at the project root:

sh config-const

This will configure server URL to be at host localhost and port 4000, along with other constants.

In cases where the server and the app are hosted on different devices, the server needs to be hosted on something other than localhost. To configure the URL to contain some other host and/or port, run:

sh config-const <your-host> <your-port>

This will configure server URL to be at host your-host and port your-port, along with other constants.

Instructions and documentation for the script can also be found by running:

sh config-const -h

Start the backend

After completing the previous steps, navigate to the project root and run

sh startserver

which will start the MongoDB database as well as the server.

Launch the app

After starting the backend, navigate to the frontend directory and run the command

npm start

to launch the app.