Repository files navigation

The gradebook that you wish you had in high school.

Remchi has been deprecated and renamed to "Remchi Legacy", as I do not have the time to continue maintaining this repository. No support of any form will be provided, but the repository will remain up and public for the foreseeable future in case others want to learn from it and/or host their own instance.

Why "Legacy"? Because I have ideas for a cross-platform, much more general grade analysis tool, and want to reserve "Remchi" for that project should it ever come to fruition...

Remchi is a modern, responsive interface that's designed to connect to Synergy's StudentVUE™ software*. It is not a replacement for Synergy, rather, a complement to it. Remchi is merely a user-facing interface to access and present data already stored in Synergy.

*This is athird party, unofficial tool. We are not affiliated with this company in any way, shape, or form. StudentVUE is a registered trademark owned by Edupoint.

In short, Remchi is intended to allow users to replace StudentVUE™, butnot Synergy.

• What you'll need: A MongoDB or MongoDB-compatible database (v3.2 or later), Node.js (v10.x or later w/ NPM v6.x or later)
• Create acredentials.json file under/secure(in the Remchi directory)
• Set thedatabase,AESKey, andsessionKey keys to your MongoDB URI and two random strings respectively. The AES key should be 16 bytes and in hex (32 chars). A new database will be created under the path listed and the session key will be used to encrypt the cookie used for seesion IDs.
• Install the necessary server dependencies withnpm install
• Start the server up withnode index.js!

At this point, yourcredentials.json file should look something like this:

{"AESKey":"(32 char hexadecimal string)","database":"mongodb://localhost:27017/Remchi","sessionkey":"(random, hopefully cryptographically secure string)"}

Many optional features will be disabled and/or unavailable under the quick start guide. Here's a list of them, as well as how you can set them up.

(please don't use "passwordN" as your actual passwords!)

{"AESKey":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","database":"mongodb://localhost:27017/Remchi","demouser":"password1","mailemail":"noreply@itsryan.org","mailpass":"password2","sessionkey":"password3","weather":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","zipLookup":"AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"}

You may have noticed atools directory included with Remchi. It contains a script,tools/patch.js, which when run will make two small changes to two of the installed NPM libraries.

1. Adds unofficial support toexceljs for implementing the filter button. Without it, the filter button will not show up for spreadsheets generated by Remchi (but all other functionality will be present).
2. Makes an attestation change tofido2-library to bypass the signature counter check if the attestation counter was set to zero. In iOS 14 (unsure if it's still the case), Apple hardcodes the counter value to zero, which normally would cause all attempts at using Face ID / Touch ID as a security key to fail. This reduces security ever so slightly, but was an acceptable compromise for me to get iOS devices working.

If you'd like to implement these changes, simply runnode patch.js under thetools directoryafter you install node_modules and it'll patch the necessary files automatically.

© 2021 Ryan Zhang.

Remchi is licensed under theAGPLv3 license. This generally means that you can do whatever you want to the code, and even commercialize it, but any modifications made must also be open sourced under this or a compatible licenseif you publicly distribute it.

Have an idea for something that'd require more permissible terms? Contact me and we can discuss!

As with all reverse engineered projects (you know, likeDolphin), it's always a good idea to throw out some disclaimers just in case :)

Edupoint® does not support nor endorse Remchi in any way. Edupoint® is completely unaffiliated with Remchi.

Remchi was fully created from reverse engineering StudentVUE's front end and mobile app, both of which are publicly accesible and did not require any form of NDA or legal agreement to not reverse engineer. This is similar to how Dolphin was legally reverse engineered from the Wii (using none of its proprietary source code).

At no point during the development of Remchi did I have access to any source code (although I am aware that Edupoint® does license it to some school districts), design documents, or any other proprietary code from Synergy. Any coincidences between the internals of Remchi and StudentVUE are purely coincidental.