README.md

📖 Read and Learn

A mobile app made with flutter, this app is made to teach and guide children on how to read. This app can compute their wpm(words per minute) and the accuracy of their reading.

💻 Technologies Used

• Firebase Database
• Flutter
• NodeJS
• NPM
• Express
• Heroku
• Rev AI

This app uses a third-party API(Application Programming Interface) named, Rev.ai to transcribe an audio file, link to the repo is this: NodeJs + Express REST API.

🔥 Features

⚡ Admin Panel	⚡ Teacher Panel	⚡ Parent Panel
✅ Manage Classrooms	✅ Manage Classrooms	✅ Join/Leave Classroom
✅ Manage Admins	✅ Manage Stories	✅ Manage User Progress
✅ Manage Stories	✅ Manage Members	✅ Manage Account
✅ Manage Teachers	✅ Manage Account
✅ Manage Parents
✅ View Certificate holders
✅ Manage Account

---

🔥 Main Features

• ✅ Compute reader's WPM(Words per minute)
• ✅ Generate certificate from the app
• ✅ Analyze reader's accuracy
• ✅ Demonstration of the word's pronounciation when the word is clicked

---

⚠️ Notice

• ✅ This app heavily relies on android devices' Microphone to record the audio and is a very crucial requirement for this app to run properly.
• ✅ This app currently does not support Offline Mode.

---

📷 Screenshots

🚪 Welcome Panel

Home Panel	Login Panel	Register Panel

🚪 Admin Panel

Admins List	Teachers List	Parents List
Stories List	Certificates List	Settings List
Logout Screen

🚪 Teacher Panel

Classes	Create Class	Classes
Stories	Pending Members	Active Members
Settings	Settings	Settings

🚪 Parent Panel

Classes	Settings	Settings
Settings	Join Class	Stories
Certificate	Active Members	Story Content
Locked Story	Locked Certificate	No Stories
Delete Account	Logout

---

📚 Database Structure

🔨 Setup

• First, create a new project in Firebase Console.
• Download google-services.json and put it in android/app/ folder.

🔒 Authentication

• Go to Authentication tab of your firebase.
• Click Sign-in Method tab.
• Click Add new provider.
• Enable Google.

🔒 Setup Hashes

• Go to Project Settings.
• Scroll down to App Settings and select your Support Account
• Scroll down and add your app's sha-1 and sha-256 hashes.

🔒 Firestore Database

• Go to Firestore Database tab of your firebase.
• Go to Rules tab
• Add the following rules into your own.
• Next, go to Indexes tab.
• Then create the following indexes.

---

💻 Compiling Application

• Open terminal and execute:

# Downloads the dependencies
flutter packages get

# Run in debugging mode
flutter run --debug

# Run in release mode
flutter run --release

---

💻 Building Application

• Open terminal and execute:

# Generates an .apk file
flutter build apk

---

📋 License

   Copyright 2021 SnoopyCodeX

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

---

Made with ❤️ by SnoopyCodeX 💻