Skip to content

Packjackisback/homeaccess-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues


Logo

HACk

A Home-Access-Center client.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is a WIP homeaccess alternate client. Currently supports out of the box credit counting, calculating needed final grades, and info, but with a little bit of code change, can give you your grades, your previous semester grades from years past, and assignments.

(back to top)

Built With

  • Built with express.js

(back to top)

Getting Started

To host this yourself you can follow these instructions.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • (node)[https://nodejs.org]
  • express npm install express
  • body-parser npm install express
  • ejs npm install ejs
  • node-fetch npm install node-fetch

Installation

  1. Clone the repo/ Download the files
  2. Navigate to root directory
  3. Start with node index.js

(back to top)

Usage

After it starts, it should automatically be hosted at localhost:3000. Visit it, enter your password, and after 8-9 seconds it should give you your data.

(back to top)

Roadmap

  • UI
  • Code Refactoring
  • Add grade calculation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the Gpl 3.0 License. See (the license)[https://www.gnu.org/licenses/gpl-3.0.en.html#license-text] for more information.

(back to top)

Contact

packjack - packjackisback@gmail.com

Project Link: https://github.com/packjackisback/homeaccess-client

(back to top)

Acknowledgments

  • API
  • Nitheesh K This wouldn't be possible without him, go give him a star!

(back to top)