Book Brother

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. App Components
6. Acknowledgments

About The Project

BookBrother is the premier mobile audio experience to listen to your epub books. Don’t have time to read or need to be somewhere else? No problem, just upload your epub to the app and click play from your library to begin getting knowledge injected into your earbuds.

Perhaps a demo?

(back to top)

Built With

(back to top)

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/rfp55-blue-ocean-blastoise/Blue-Ocean-Blastoise.git

2. Install NPM packages

   npm install

3. Run client

   npm run react-dev

4. Run server

   npm run server

5. Create your own config.js

   responsive: 'token for voice',
   mongoPW: 'mongo password here',
   aws_secret_access_key : 'YOUR_SECRET_ACCESS_KEY',
   aws_access_key_id : 'YOUR_ACCESS_KEY_ID',
   aws_bucket_region: 'YOUR_BUCKET_REGION',
   aws_bucket_name : 'YOUR_BUCKET_NAME',

(back to top)

Usage

• Refer to this for API usage.
• Refer to this For Voice Commands.
• Refer to this For Book Player Features.

(back to top)

Contributing

Refer to this before beginning work on the project to setup your feature branch correctly.

(back to top)

App Components

Book Viewer and Narrator

• Developed by Justin Beere, Kevin Gao, Lenora Esquenazi, Matthew Boyle
• Allows users to read an EPUB book along with a narration of the text. Users can change text size, speed, pitch, voice and choose to listen to a fireplace background if they so choose.

Text-to-Speech and eBook Renderer Engineer

• Developed by Daniel Ho
• Managed the eBook rendering and text-to-speech functionality for the Book Viewer and Narrator component, enabling real-time narration of rendered eBook display for the user.
• When the user opens an eBook, narration will be initiated automatically. User is able to read and listen continuously, with the viewer automatically flipping to the next page once the current page has finished being narrated.
• User may pause the narration for any amount of time and resume where he or she left off.

Library and Voice Recognition

• Developed by Huong Nguyen
• Library page displays a list of EPUB books available in the app. The "My Account" page displays a user-specific list of EPUB books separated into 2 sections: "Reading Now" and "My Books". Users can search and sort through the books, as well as upload a personal EPUB or add an EPUB book from the library to their account. Users can also play a book, remove a book from the "Reading Now" section, and delete a book from their account.
• Users can use voice control to interact with the library and the book player by simply clicking on the microphone button to speak commands (please refer to the voice command list)

Backend Architecture, Database and Authentication

• Developed by Aaron Tran and Andrew Cho
• We chose MongoDB to represent each document as a user with their own personal array of books and each book object will have a bookmark and the link to the EPUB file. The EPUB files are hosted in Amazon S3 on upload.
• For authentication, we used Firebase to handle the user credentials alongside React Context to update the current user's MongoDB document on update. Firebase methods are also used for session persistence to enable a logged-in state.

(back to top)

Project Link: https://github.com/rfp55-blue-ocean-blastoise/Blue-Ocean-Blastoise

Acknowledgments

• Amazon S3
• React Reader
• Epub.js

(back to top)