Skip to content

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

License

Notifications You must be signed in to change notification settings

SnoopyCodeX/read_and_learn_app

Repository files navigation

πŸ“– Read and Learn

Developed by SnoopyCodeX

Github Release

Github Star Github Fork License

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

Flutter Firebase NodeJS NPM ExpressJS Heroku

  • 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
s1 s5 s6

πŸšͺ Admin Panel

Admins List Teachers List Parents List
s1 s5 s6
Stories List Certificates List Settings List
s4 s3 s2
Logout Screen
s8

πŸšͺ Teacher Panel

Classes Create Class Classes
s1 s2 s3
Stories Pending Members Active Members
s4 s5 s6
Settings Settings Settings
s7 s8 s9

πŸšͺ Parent Panel

Classes Settings Settings
s1 s2 s2
Settings Join Class Stories
s4 s5 s6
Certificate Active Members Story Content
s7 s8 s9
Locked Story Locked Certificate No Stories
s10 s11 s12
Delete Account Logout
s13 s14

πŸ“š Database Structure

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. Enable Googlle

πŸ”’ Setup Hashes

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

πŸ”’ Firestore Database

  • Go to Firestore Database tab of your firebase.
  • Go to Rules tab
  • Add the following rules into your own. Rules
  • Next, go to Indexes tab.
  • Then create the following indexes. 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 πŸ’»

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages