README.md

NightyNight Stories

This app offers children a fun storybook experience while improving their reading skills. Kids who read the text correctly are rewarded with magical animations.

Getting Started

Follow the steps below to set up and run the project on your local machine.

1. Prerequisites

• Android Studio
• API keys for integrating with Google Cloud Speech-to-Text API
• A mobile device or emulator running at least Android 6.0 (Marshmallow)

Note: The images and videos used in the application are not included in this GitHub repository. You will need to create and add your own visuals and videos.

2. Installation

Clone the repository:

• https://github.com/ErayBD/nightynight-stories.git

Build the project

• Open the project in Android Studio
• Update the Gradle configuration to install necessary dependencies:
  • ./gradlew build

3. Configuration

Google Cloud Speech-to-Text API:

• Create a project in the Google Cloud Console
• Enable the Speech-to-Text API and create a service account.
• Copy the generated JSON key file to the app/src/main/res/raw/ directory.
• Update this line in "StoryBook.java":
  • InputStream credentialsStream = getResources().openRawResource(R.raw.YOUR_JSON_FILENAME);

4. Running the Application

To run the application in Android Studio:

• ./gradlew installDebug

5. Using the Application

Here’s how to use the application:

• Story Selection: When the app launches, the user is presented with three story choices. Currently, only the first story is active.
• Chapter Completion: To complete a chapter, the user must read the text correctly. Words that are read correctly turn green. Once the entire text is read correctly, a video replaces the static image, and the next chapter unlocks.
• Locked Chapters: Chapters that have not yet been completed are displayed with a blurry effect.

6. In-app Screenshots

6. Application Introduction GIF

7. Application Introduction Video