Student is an alternative client for StudentVUE®, a popular school LMS software used in the US. It features a refreshed UI with more powerful features to help maintain academics.
StudentVUE® is a registered trademark of Edupoint Educational Systems, LLC. This project is not affiliated with Edupoint or Synergy.
The app features a gradebook, schedule, calendar, attendance, documents, mail, test history, and school information. It has a clean interface and powerful features like Hypothetical Mode to make use easier. Student does not store, see or keep any of your personal data, a full privacy policy can be read here.
Student is a Next.js app, using TypeScript.
Tailwind CSS is used to make CSS easier and cleaner in the app using class (referenced as className) tags in the code.
Student's interface uses shadcn/ui as a foundation and component template.
Student uses multiple SOAP (and REST) based internal Synergy APIs, hosted on the student's district synergy server. Not all of these are documented, and I may document them later.
The student has no required environment variables, and running a development instance just requires starting a Next.js server. If you are not familiar with this, these steps will walk you through how to do it.
- First, choose a package manager. I won't explain what they are as it's pretty common knowledge. For this example, I am going to use
bunfor this. Each package manager acts pretty similar. - Install the dependencies for the app, you can do this by running
bun i
- Next, spin up a development server.
bun dev
This should make a web server on your local machine which you can visit with the app. (it will say it on the bun dev command, default is port 3000)
- Before pushing your code/making a pull request, make sure to build your code to make sure it works in production. This can simply be done by running
bun run build
Important
Student is hosted on a GNU-AGPLv3 license. The full license can be found here. Please keep it in mind when making changes or hosting. This app is hosted by Vercel, all commits to this repository will be pushed to Student through Vercel.
If you want to host yourself, I recommend Vercel as well. Their free plan is very generous and should be fine for most uses.
