Giter Club home page Giter Club logo

schedule-personalizer's Introduction

Schedule Personalizer v5

Complete rewrite of Schedule Personalizer, with new features!

Schedule Personalizer is a self hosted school schedule website/web app that displays the schedule for the current day. It is very customizable and will work with almost any school. If Schedule Personalizer isnt compatible with your schedule, please open an issue on GitHub, we would be glad to throw in support for it!

Component locations

Components that are only used for one page should be put into src/pages/<page>/components while components used for multiple pages go into src/components

Possible features to consider adding?

  • Site updates in the background when theres a new commit to the git repo
  • Allow storing config (or schedules and events) in a database and make it writeable from a UI ?
  • Multipe school config, so a school district can host one instance of schedule personalizer for all their schools
  • Lunches can be based on multiple periods (oh goodness thatll be complex as hell)
  • Support for other gradebook/student info sites other than StudentVue
  • Support for multiple schedules in a day for support of studdents who are in other during school programs like Cambridge and Running Start ??? (Working progress)
  • Customizable teacher and class name character case (upper, lower, title, regex, array of class abbreviations to be changed)?
  • add a “view full schedule mode” that shows the times for all lunches (Create issue for this and actually implement)
  • support for other languages, might be somewhat pointless because of google translate but might be a good idea still

Setup

You will need

  • Yarn
  • Node.js

Install dependencies by running:

yarn

Config

Read src/config/readme.md for info about configuring Schedule Personalizer.

Build

yarn
yarn build

Files to be served are in dist/

dev run

yarn
yarn dev

schedule-personalizer's People

Contributors

dependabot[bot] avatar insberr avatar levicantcode avatar ttury avatar webmsgr avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

schedule-personalizer's Issues

Update the readme and add example config files. And some general things to make this useable by almost any school.

Readme should describe the build process and how schools can set this up for their own use, because that's the goal is that any school can use this.

Also might be good to have a defined way that pull requests can be sent? And also feature suggestions?? Like if some school wants a feature added.
Features like support for other school info platforms other than StudentVUE ?? Or that could be described as something that should be set up as a separate api?? Idk.

Might also be a good idea to add hybrid/remote support?

Auto updating to do

@webmsgr said
add feature to only try reloading 3 times
make autoupdating do a cool thing called not fading in
give up a first born to the code gods

Thats the to do list

Add more animations

Would be cool, helpful too.

  • Add slide or fade (idk) animation to schedule when changing the day

Set v1 to redirect users to new url.

This is to update the pwa icon and url and stuff. Detect if the url is insberr.github.io/schedule-personalizer and redirect users to the new url with a query of ?isv1=true that’ll bring up instructions on how to reinstall.
or is it pointless to do this? Should we straight up just update the master branch and not redirect users to reinstall the pwa for the new icon and splash screen? Could we somehow detect if they are on the old pwa? I wish pwa icons would update but I’m pretty sure they don’t do that’s pain.
Add the alert when v5 is stable, or at least all pwa related updates are taken care of like #25

Cambridge schedule support

Seems Cambridge people have periods 3, 4, 5 and then 11, 12, 13
Not sure what the order is supposed to be for those lmao.

Multi school config

Let's say a school district wants to use the site for all their schools, would be nice to only have to host one website and then in the config folder you have a folder for each schools config

reset button

Make the reset button clear cache and unregister the service worker.

Add all known schedules, events, and lunches.

We can add events already. We will need to wait till closer to the first day of school for the schedules and lunches. tho we can implement the schedules from last year (I doubt they changed)

Lunch may not be correct error

If all the events on a day (not sure if it's if there's some too) are schedule type null then it says lunch may not be correct. Pls fix soon ™️

add logout button.

A logout button that just logs you out of studentvue and removes your studentvue data, but leaves your schedule data and customizations.

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.