Skip to content

User Manual

Jump to bottom
Arjun Raghavan edited this page Mar 8, 2021 · 15 revisions

How to Install

On Android

Connect an Android phone to the computer and follow the instructions to enable USB debugging: https://reactnative.dev/docs/running-on-device

$ git clone https://github.com/cs130-w21/book.ar.git
$ cd book.ar/BookAr
$ yarn install

In two separate terminals, run the following commands:

$ yarn android
$ yarn start

On iOS

Please follow the following guide on launching React Native apps in iOS: https://reactnative.dev/docs/running-on-device

How to Use

  1. Register through Firebase authentication with your email address. You can also input your preferences to personalize what recommendations you receive.
  1. Use the navigation bar to view the Home, Select, or Profile screen
  1. On the Select screen, you can choose to take a picture or submit an image from your gallery. Be sure the image clearly displays the book title(s).

Recommended books will be displayed in the lower portion of the screen.

  1. The home screen displays a list of recommended books, and books that you are currently reading.

You may click on these books to add them to your reading list or ignore them.

  1. Books will be placed into your currently reading. You may then click on the book again to select whether you liked the book.

  1. The Profile Screen gives the user the ability to sign out or update genre preferences.

Notes

The current version of React Native has a timer warning issue on android. The app functions perfectly fine, but if you want to fix on user side:

  1. Navigate to your node_modules/react-native/Libraries/Core/Timers/JSTimers.js file.
  2. Look for the variable MAX_TIMER_DURATION_MS
  3. Change its value to 10000 * 1000
Clone this wiki locally