Giter VIP home page Giter VIP logo

frosthack's Introduction

 Project Logo

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
  2. Run read-story.html file.
  3. Signin page will be opened, Enter following credentials
  4. Credentilas for testing, we have flooded this with data
    email: [email protected]
    password: test@password
  5. You can create new account by signing up & check for it too

โœ 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 1 Page

SignUp(2) Page :

SignUp 2 Page

Login Page :

 Login Page

Read-Story Page :

Read-Story Page

Statistical-Data Page :

Statistical-Data Page

Firebase Realtime-Database :

Firebase Realtime-Database

Firebase Storage :

Firebase Storage


๐Ÿ˜Ž Contributors :

frosthack's People

Contributors

sahil-777 avatar pratikpz18 avatar

Watchers

 avatar

Forkers

pratikpz18

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.