Skip to content

Latest commit

 

History

History
197 lines (146 loc) · 7.59 KB

README.md

File metadata and controls

197 lines (146 loc) · 7.59 KB
Raw

Aspine

Aspine is a website that makes it easier for CPSD students to access and predict their grades. For example, a student can use Aspine to see how a better score on a test or an A on an upcoming project would affect their grade in a particular class as well as their GPA.

Getting Started

Using Aspine is as easy as 1-2-3. Just visit https://aspine.cpsd.us and log in with your Aspen credentials.

If you have an iPhone and would prefer to use an app instead of the website, there is an Aspine app on the iOS App Store. You can also select "add to home screen" from the share sheet to make the Aspine website function like an app.

Features

  • Aesthetic grade checking

  • CRLS clock

CRLS Clock Image

  • Grade comparison via boxplot

Example Boxplot Image

  • Export and import your grades

"Export Data" dialog box

FAQ

How are usernames and passwords handled?

Short answer: Aspine does not store any usernames, passwords, or student data. Moreover, https://aspine.cpsd.us is hosted on CPSD servers, so your data are safe in any case.

Long answer: Aspine works by simulating a login on Aspen and formatting the data received. In doing this, it must transmit your username and password to the Aspen server. However, your login information is transmitted completely over encrypted connections (HTTPS), and it is not retained by Aspine at all. This can be verified by anyone who can read code, as all of our code is out in the open on this repository. If you are particularly paranoid, you can run Aspine locally on your computer instead of using the https://aspine.cpsd.us instance; instructions are below in the section "Contributing / Locally Running Aspine".

How are calculated grades computed?

First, calculated category percentages are computed by dividing a student's total earned points within a category by the total available points for that category. Then, the category percentages are multiplied by their respective weights and summed in order to produce the calculated grade for a class.

Note:

  • Assignments scored with free text (i.e. "Missing", "Exempt") are ignored during grade computation. (Improvements coming soon)
  • Due to the mysterious workings of Aspen, it is impossible to achieve 100% accuracy when making grade prediction calculations. That being said, Aspine's cutting edge grade calcuation algorithm is unmatched.

Aspine Lite

If you have a grade export (as a JSON file) and want to view it using Aspine, you may run into the problem that the current version of Aspine is too new to view your JSON file (or you just want to view your grades offline). We have created a variant of Aspine called "Aspine Lite" which contains the complete Aspine user interface but without connecting to Aspine or Aspen servers over the Internet.

Downloads for Aspine Lite can be found under "Assets" on the Releases page on GitHub. To use Aspine Lite, simply download the zip file, extract it to a folder, and open home.html in a Web browser.

Contributing / Locally Running Aspine

Feel free to suggest an enhancement or report a bug either via GitHub issues or this form!

If you would like to directly contribute to Aspine, you can fork this repository and clone your fork on your computer with a git client. Please use the master branch as the base of your changes.

If you would just like to try out Aspine on your computer, you can click on the green "Code" button above the file list and download and extract a ZIP file with Aspine.

  • Make sure that you have installed node.js, including npm.

    • On Linux-based operating systems, you should be able to find node.js in your package manager (e.g. apt/dpkg, yum/dnf, zypper, pacman, or a GUI such as Ubuntu Software Center or GNOME Software); npm may be in a separate package.

    • On macOS, node.js (including npm) is available on Homebrew as node.

    • On Windows, the node.js installer can be downloaded from the website. Run the installer and follow the on-screen instructions.

  • Install additional dependencies through node.js (this must be done each time you clone or download Aspine) by opening a terminal in the directory where you cloned or downloaded Aspine and running npm install.

  • Start the Aspine server by running npm start in a terminal window (or Command Prompt on Windows). If you are on a Unix-like system, you can run npm start & to run the server in the background and then run killall node when you want to kill the server.

Authors

Color Scheme

Light Mode

Color Palette

Primary Color: #00551D
Secondary Colors:
 - #268A48
 - #107031
 - #003913

Dark Mode

Color Palette

Primary Color: #00CC44
Secondary Colors:
 - #00A336
 - #00B83D
 - #00FF52

Grade Lettering and Coloring

Grade Range Letter Primary Color Secondary Color
96.5 - 100 A+ #1E8541 #3d995c
92.5 - 96.4 A #1E8541 #3d995c
89.5 - 92.4 A- #1E8541 #3d995c
86.5 - 89.4 B+ #6666FF #a3a3f5
82.5 - 86.4 B #6666FF #a3a3f5
79.5 - 82.4 B- #6666FF #a3a3f5
76.5 - 79.4 C+ #ff9900 #eba947
72.5 - 76.4 C #ff9900 #eba947
69.5 - 72.4 C- #ff9900 #eba947
66.5 - 69.4 D+ Orange #ebb147
62.5 - 66.4 D Orange #ebb147
59.5 - 62.4 D- Orange #ebb147
0 - 59.4 F Red #eb4747

Privacy

Our privacy policy can be viewed at https://www.cpsd.us/privacy.

License

Copyright Aspine contributors 2019–21.

Aspine is free/libre and open-source software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License (version 3) along with this program (see file LICENSE.md). If not, see https://www.gnu.org/licenses/.