Read Story

A website for creating a reading habit for students.

FrostHack

FrostHack - Open Hackathon organized by student community with the goal of solving societal problems by collective collaboration among students using tech.

🎞️ Video Link :-

https://screenrec.com/share/Cv9NgxhDqi

📝 Instruction :-

1. Clone the repository git clone https://github.com/sahil-777/FrostHack.git .
2. Connect To Firebase.
3. Create Project in Firebase named FrostHack and in Realtime database add json.file provided in code.
4. Add stories file in Firebase Storage(check assets/stories files folder).
5. Run read-story.html file.

Note: Please use following credentilas for testing, we have flooded this with data
email:         test@readbook.com
password:   test@password

✍ Dependecies

• Dictionary Api - Get apiKey from here by registering yourself and add your own apiKey.
• Firebase - You need to have Firebase account and create a project named FrostHack.

⚙ Functionality:

Read-Story Page :-

Here stories from Firebase Storage is fetched and displayed.

• Stories will be displayed with a timer of 5 min.
• After child finishes reading there will be a button named done after clicking that 5 points will be added to his data and page will reload with new story.
• In case,a unknown word encounters he/she can search the word for meaning in navbar search box.
• After every refresh The story will change in case he/she wants another story.
• Child can read stories how many they want and will allot 5 points for one story.

Statistical-data Page :-

Here we Use Firebase Realtime Database data and calculated points using Javascript.

• In this page,data will be shown comparing previous week and current weeks performance.
• According to ones points scored data will be shown in Statistical format.

SignUp Page :-

For SignUp we use Firebase Authentication

• Email address to be associated with the user’s profile and serve as login name.
• Password which will be used to log into the site.
• Confirmation of password.
• Once user has finished providing required Manual Signup input, they must click ‘Sign Up’ to trigger registration validation and completion of the registration.

Login Page :-

For Login we use Firebase Authentication

• Email address to be associated with the user’s profile and serve as login email.
• Password which was used while registering account.

🙏Credit :-

1. Thanks to Dictionary Api - For Api Key for finding meanings of word.
2. Thanks to Swal - For custom modal showing success/error messages.
3. Thanks to Template - HTML Template.

⛏️✍ Built Using

• FIREBASE - NoSQL Database
• HTML - HTML is the standard markup language for documents designed to be displayed in a web browser.
• JAVASCRIPT-JavaScript is the programming language/scripting of the Web.
• CSS - CSS describes how elements should be rendered on screen, on paper, in speech, or on other media.

Screenshots :

SignUp(1) Page :

SignUp(2) Page :

Login Page :

Read-Story Page :

Statistical-Data Page :

Firebase Realtime-Database :

Firebase Storage :

Firebase Authentication :

😎 Contributors :

- Sahil Velhal

- Pratik Zinjurde