Git Product home page Git Product logo

schedulecheck's Introduction

ScheduleCheck

AKA: AspenCheck, AspenInfo, X2Info

ScheduleCheck is a program that gets information (such as schedule information) from Aspen. It is currently used as the backend for the Melrose High School's AspenDash.

Any district using the Follett Hosted version of Aspen (with domain ending in myfollett.com) can use several features of ScheduleCheck without needing a specialized configuration. If your district has a custom url, feel free to add it to the config.json, or make a ticket.

The endpoints are subject to change at any time, and should not be used in production environments.

Endpoints

We publish OpenAPI / Swagger data. To see our endpoints, visit the swagger docs.

schedulecheck's People

Contributors

herocc avatar tomscudder avatar veldrovive avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

schedulecheck's Issues

Improve backend Cache system

  • Refresh more often when blocks are expected to change
    • In the prior and post 5 minutes during expected block change
  • Do not stall web requests during refreshing
    • Right now it stalls all web requests and runs the jar multiple times, this is not good
  • Be comparable with future web hooks
    • Webhooks will be in a future ticket, but ensure the refresh / cache system still works when we eventually migrate to that
  • Ensure it is tolerant of user-specific requests
    • Right now it accepts a username and password post parameter, ensure the user specific stuff is still not cached

Incorrect block and "isClassInSession" value returned

The Api currently always returns true for isClassInSession and C block for the current block. I know that you already know about this, but it would be nice to have it fixed.
Also, no I can't do that because I have no idea how ScheduleCheck even works.

Addition of Start/End time for each block

In order to dynamically update timers, it would be useful to have a field in the schedule endpoint that gives start and end times for each block. Just returning timestamps like it has in the picture would be fine, but it would be best to return a formatted date object whether that is in a string or a number of seconds or milliseconds in order to reduce complication on the front end.
screen shot 2017-12-22 at 10 57 10 pm
For formatting, a possibility would be
"blockTimes": [{"block": "A", "start": "1514001963005", "end": "1514001979926"},...]
This would allow for easy access to both the block letter and timing information as well as opening possibilities for additional fields to be added to each block without breaking existing applications.

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.