Skip to content

suraj-yadav-001/GN-Core

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome! 👋

Build Status

What is Grade Notifier?

Great question! Let me highlight a few of our strengths:

Features
🚨 Get Notifier when a new grade is posted
Available to all CUNY schools
📧 Works with email (coming soon...)
📱 Works with phone
Save time
😰 Reduce stress
👨‍👩‍👧‍👦 Open source

We aim to allow students to enjoy their vacation instead of checking every minute to see if their grades were released. We check every 5 minutes for you and notify you in case of a grade change.

How do I use Grade Notifier?

To get started head over to our website: Grade-Notifier

The guide on the site should help you get started!

Contributing

Hey! You're looking to contribute to Grade-Notifier? That's awesome!! This is a college project so the hope is that students over the years will help maintain it. If you're interested, the community thanks you!

There are currently 3 main ways you can help contribute:

  1. Improving the website
  2. Building out the script
  3. DevOps, making sure the project doesn't hiccup

I want to contribute but...

Reach out [email protected] or [email protected]. We're happy to walk you through how git works, how the project is structured or anything else.

Quickstart

Requirements:

  • macOS/Linux
  • git installed
  • ruby installed (should come preloaded on those 2 OS)

If your looking to get going quickly checkout our Starter file. It can be downloaded here: Grade-Notifier Starter file

  1. Make sure you have jumpstarter installed. If not type into your terminal (anywhere) gem install jump-starter

  2. Have your Github username and password on hand.

  3. Simply drag the Setup file (that you just downloaded) into the folder of your choice and run jumpstart start in your terminal (make sure your in the proper directory).

Thats it! Your good to go!

For a walkthrough of the non-quickstart approach check out the contributing guide.

Open Source & Copying

We open source this repository for 2 main reasons:

  1. We hope that a project like this will excite fellow students and give them a project to work on. We know getting started on projects can be tough and we hope this helps get you coding!

  2. This project is susceptible to breakage at any point. Being that it relies on CUNYFirsts website the code and URL's are subject to changes and not in our control. For that reason, constant maintainence and updates could be necessary. As much fun as we had building this, we can't keep ontop of it.

We have chosen to use the MIT License to allow students to make use of the code inside the project but do not distribute this software commercially paid or free.

FAQ

Q: Do you store passwords?
A: No way! You password is never stored on our server and we never get a chance to see it.

Q: Do you store usernames?
A: Yes we do. In order to restrict users from signing in multiple times we keep track of which usernames are actively using the service. If you have any questions about that please contact me @ [email protected]

Q: Do you store any other information?
A: We retain the right to store any non-user specific data. For example, we will NEVER look at you and your grades but we may capture that some person got a A+ in a certain class. Again, your name will never be associated with that grade and we will have no way of knowing where that grade came from. If you have any questions about that please contact me @ [email protected]

Q: I signed up but didn't get an initial text
A: Wait a few more minutes sometimes the system are overloaded and the message takes time to send. If you still haven't received a message after 10 minutes it could be there was an issue, just try signing up again. If it persists, reach out. We're happy to help.


Check out the contributors section to see all the amazing people who have helped maintain and grow this project!

Made with ❤️ by Ehud Adler & Eric Akiva Sherman. Thank You.

About

Stop checking for your grade and just get notified

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 59.9%
  • SCSS 16.2%
  • PHP 14.7%
  • Ruby 5.8%
  • JavaScript 2.2%
  • Shell 1.2%