Project Title

1. Project Description

State your app in a nutshell, or one-sentence pitch. Give some elaboration on what the core features are.
This browser based web application to help people improve their sleep schedule.

2. Names of Contributors

List team members and/or short bio's here...

• Hi my name is Shayan and I'll be working on coding and project managing in this project.
• Muhammad (Sherry) Jameel, I'm the designer :3
• ...Coda Miles, i made the repo :)

3. Technologies and Resources Used

List technologies (with version numbers), API's, icons, fonts, images, media or data sources, and other resources that were used.

• HTML, CSS, JavaScript
• Bootstrap 5.0 (Frontend library)
• Firebase 8.0 (BAAS - Backend as a Service)
• Google fonts
• chart.js
• Sweet Alert

4. Complete setup/installion/usage

State what a user needs to do when they come to your project. How do others start using your code or application? Here are the steps ...

• First, after the sign up, they have to answer a few questions about their sleep scheduale which there is a button for it in the main * page.
• Second, they would receive a schedule from the system to help them
• And the last step is to commit to the instructions and new scheduale
• User can input sleep length and quality to form a graph showing their data over time
• Note: The user is able to input the quality of the sleep they had from the last night only one time per day, and overtime, the
• the chart would be filled out more and more everyday based on the data it will receive.

5. Known Bugs and Limitations

Here are some known bugs:

• inputing a number greater than 24 on survey
• survey only accepts full hours and only 24 hour clock (no 8:30 PM)
• the questionnaire for the graph inputs gets locked out for 12 hours after submitting, but its tied to the browser local storage and not the account, so if you have multiple accounts or log in on a different device the questions might be there or might not

6. Features for Future

What we'd like to build in the future:

• better schedule and notifications
• better math for survey and schedule
• survey accepts half hours and such and 12 hour clock with AM / PM
• More details on the meditation page
• More details for the schedule

7. Contents of Folder

Content of the project folder:

 Top level of project folder: 
├── .gitignore               # Git ignore file
├── .firebase 
        hosting..cache
├── 404.html
├── edit-password.html
├── edit-profile.html              
├── firebase.json
├── firebaseindex.html
├── firestore.indexes.json
├── fierstore.rules
├── index.html              # landing HTML file, this is what users see when you come to url
├── login.html
├── main.html
├── meditation.html
├── package-lock.json
├── package.json
├── profile.html
├── progress.html
├── README.md
├── schedule.html
├── settings.html
├── skeleton.html
├── survey.html
└── update.html
It has the following subfolders and files:
├── .git                     # Folder for git repo
├── images                   # Folder for images
    /settings.svg            # https://www.svgrepo.com/svg/13646/settings
    /home.svg                # https://www.svgrepo.com/svg/13696/house
    /zzz.png                 # https://images.emojiterra.com/openmoji/v15.0/256px/1f4a4.png
    /yinyang.svg             # https://www.svgrepo.com/svg/479216/yin-yang-taiji-diagram
    /progress.svg            # https://www.svgrepo.com/svg/510284/trend-up
    /schedule.svg            # https://www.svgrepo.com/svg/447776/schedule
    /profile.svg             # https://www.svgrepo.com/svg/522440/profile
    /colourPalette.png       # https://coolors.co/31593b-539258-bd8d65-caae91-6a2e35
    /logout.svg              # https://www.svgrepo.com/svg/334065/log-out
    /bad.png
    /moderate.png
    /happy.png
    /very bad.png
    /very happy.png
    /zzz.png                    
├── scripts                  # Folder for scripts
    /authentication.js       # 
    /client.js        
    /edit-password.js       # 
    /edit-profile.js       # 
    /firebaseAPI_BBY30.js       # 
    /hideProgressSurvey.js       # 
    /main.js       # 
    /profile.js       # 
    /progressGraph.js       # 
    /schedule.js       # 
    /script.js       # 
    /survey.js       # 
    /update.js       # 

├── styles                   # Folder for styles
    /style.css               #