Git Product home page Git Product logo

Comments (1)

ElizaJ04 avatar ElizaJ04 commented on August 23, 2024

How to use LCHS Go
A comprehensive guide (Version 1.0)

Table of Contents
Part 1: Overview
Part 2: The "Now" Page
2a: Bell Schedule
2b: Now page
Part 3: The "About" Page
3a: Credits
3b: Settings
3c: Log

Part 1
-----------------
Overview
Welcome to LCHS Go, a progressive web application developed by students at LCHS. This app allows you to:

  1. Know what period it currently is

  2. Know the time until next period

  3. Easily find a bell schedule of the current day

This app is also accompanied by an extention, which is more convenient, as it will open on the page you are currently on. The extention, however, will not allow you to customize the application while on it. However, navigating to the webpage to change your settings will continue with the extention installed.
To install the extention, click here:
https://chrome.google.com/webstore/detail/lchs-go/cmmaleejnmjplfcnhojldkiejpndakad

This app is very intuitive. It also updates automatically, without the need to refresh.
All of the nessary information will be displayed on the "Now" page, the page that appears initally when on the website, and the page that appears when clicking on the extention.(Part 2)
All of the settings can be accessed in the "About" page.(Part 3)

Part 2
---------------
The Now section
When the large "Now" button is selected, smaller buttons, marked "Now" and "Bell schedule", appear initally.

2a: Bell Schedule
The "Now" button will be selected initally. However, by clicking the "Bell Schedule" button, you will be brought to the bell schedule subsection, which shows the bell schedule of the current day of the selected grade(See part 3B to learn how to change the current grade).

2b: Now Page
The Now subsection, which is the inital section, can be accessed by clicking the aforementioned smaller "Now" button. The Now subsection has three subsections:
1.Current Period
This section shows which period is currently happening for the selected grade.
2. Period End/Until Next
This section shows how much time is remaining until the next period. By clicking this section, the text below will toggle between showing the name of the next period and how long until it, and the time remaining for the current period.
3.Current Time/Last updated
This section shows the current time. This app updates automatically, without the need to refresh, so the current time will always be that of the Pacific Time Zone(assuming the application is working).

Part 3
---------------
The About section
The "About" section is exclusive to the web app. The extention does not have the "About" section. To navigate to the "About" section on the web app, simply click the large button located near the top of the webpage marked "About".

3a: Credits
This section can be accessed by clicking on the word "Credits".
The credits subsection has 2 main parts: a QR code to share the application with another person, and the credits for the application. The QR code can be accessed by a QR code scanner, which will open the application on the device that scanned the code. The credits list is self explanitory: It is a list of those who have worked on the application.

3b: Settings
This section can be accessed by clicking on the word "Settings".
The settings subsection allows the user to customize the application. Currently, there are 6 customizable settings, and the application version for use in bug reports.
1.Grade level
The Grade Level setting has a "drop down menu". The grade displayed on the menu is the currently selected grade. The user simply has to click on the menu and a list of options will appear and then click on the grade level you wish to select. (Default 9th grade)
2.Time Display
The Time Display setting has two buttons: 12hr time and 24hr time. The currently selected option will be highlighed by a darker color. Simply click on the time display method you wish to use to select it. (Default 12 hr).
3.Enable Theme Animations
The Enable Theme Animation setting has two buttons: Enable and Disable. Like the the time display, the currently selected setting will be highlighted by a darker color. By disabling ths option, the theme will not change colors and will remain a static gradient.(Default Enabled).
4.Enable Blinking
The Enable Blinking setting is used exactly the same as the Enable Theme Animations setting. By disabling this option, the colon on the current time section of the Now section(see part 2b for more detail) will not blink. (Default Enabled).
5. Show Hidden Periods
The Show Hidden Periods setting once again has two buttons: Show and Hide. Like the the time display, the currently selected setting will be highlighted by a darker color. By clicking show, hidden periods(passing periods) will show as periods in the Now section(see part 2b for more detail). (Default Hide).
6.Color Theme
The Color Theme setting operates similarly to the Grade Level setting, where a "drop-down" menu will appear, which will allow the user to select which color theme they wish to use. This setting is purely cosmetic and will not effect the app's functionality. Disclaimer: the app may be less usable and may be harder on the eyes with some themes (Default: Violet Delight)

3c: Log
This section can be accessed by clicking on the word "Log".
The log section contains information/news related to the development and updates of the application. By clicking on any of the headers, a longer article will appear below.


That's all you need to know!
Thank you for using LCHS GO!

-Ean Jeffries

from lchs-go-pwa.

Related Issues (20)

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.