Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 2.38 KB

UserManual.md

File metadata and controls

30 lines (21 loc) · 2.38 KB

User Manual

Description

DeBored is a mobile application that helps users fight boredom through providing tailored hobby and activity suggestions, and fostering friendships between users with shared interests. If you find yourself bored, DeBored is here to help!

Installation and setup

To install DeBored:

  1. On a mobile phone, install the Expo Go app on your mobile device from the App Store or Google Play Store
  2. On a Windows, Linux, or Mac OSX machine, install the Node.js runtime (v18.18.2) using the link here
  3. On the same machine, install Git here This is necessary in order to build, test, and the run the system
  4. On the same machine, open a command line/terminal window, navigate to any directory that you would like to store the DeBored source code in. See here for more info on navigating directories in command line/terminal
  5. In the desired directory, run git clone https://github.com/ttrenh/DeBored.git to clone the DeBored source. Refer to Directories for the layout of our directory structure
  6. Run cd DeBored/frontend from the cloned root directory
  7. Run npm install to install dependencies

Running the App

To run the app:

  1. Navigate to the frontend directory, (run cd frontend from the root directory)
  2. Run npm expo start to start the app
  3. Scan the generated QR on your mobile device to launch the project

Using the App

In order to provide tailored suggestions, you will need to create an account through the app. Please sign up and login to get started! After logging in, you will be redirected to the homepage and can start getting DeBored!

Report Bugs

Please report issues in the app public Git repository using the bug report template. Refer to Issues for current known bugs and limitations.