Skip to content

Latest commit

 

History

History
145 lines (100 loc) · 8.59 KB

README.md

File metadata and controls

145 lines (100 loc) · 8.59 KB
Raw

Logo

EduPage2

The fastest client for EduPage

Report Bug . Request Feature

GitHub tag (latest by date) Downloads Contributors Issues License codecov Discord

test-coverage build-patch-android

Table Of Contents

About The Project

If you have ever used EduPage, you already know that it's slow. And not just on the school Wi-Fi network, where there are hundreds or thousands of other people, using the network at the same time, but also on your home network, which should be faster right? Well, your network is in most cases faster than the school network, which indicates, that the issue is not on our side, but rather EduPage's servers just being slow.

And that's why we made EduPage2. So far, EduPage2 lacks a pretty big amount of features, that are included in the official app. But don't worry! With almost daily updates, we are constantly releasing new features, and optimising the existing ones.

EduPage2 uses local caching on your device, and a caching server with our own privte software, which periodically updates data from EduPage, strips it of all useless data (which EduPage includes for some reason), and finally sends out to your device when requested.

Backend Status

Quick status

Host Status
Render.com Better Stack Badge
Deta.space Better Stack Badge

Statuspage

Currently there are two status pages for the EduPage2 backend. The one on Better Stack which we have confirmed to work, and the other one on Statuspage which seems to work, but we will have to wait unitl an outage occurs to test that.

Disclaimer

EduPage2 is an open-source project with contributions from multiple individuals and is not affiliated with or endorsed by the creators of EduPage. EduPage is a separate and (possibly) trademarked platform owned by asc Applied Software Consultants, s.r.o.

Please note that while EduPage2 is designed to work as a drop-in replacement or alternative mobile client for EduPage, it is not officially supported by the EduPage team. Any issues or inquiries related to EduPage2 should be directed to the project's GitHub Issues provided in this repository.

This project is open source and distributed under the GPL-3.0 license, and all contributions are welcome from the community. However, use it responsibly and in compliance with the terms of use of the original EduPage platform.

Built With

This is a list of all the main tools, libraries and frameworks, that were used in this project

Getting Started

All our backend stuff is luckily managed by us, which makes getting started very easy for you.

Prerequisites

Make sure that you already have an EduPage account. Since this is a client, you need to already have an account at EduPage, to use EduPage2.

Installation

If you want to build the code yourself, all the code is provided in this repository, you can download it, and build it on your own machine.

Otherwise, you want to head to our releases page, to download the latest release. We hope to release to the Google Play Store soon, however we currently lack the finances...

If you want to run this code on an iPhone, you will have to download the source code and build it yourself, as we do not have the finances to get an Apple Developer account, and there is no way to distribute iOS apps other than through the App Store at this time.

Usage

Once you have the app installed, it is as easy as opening up the app, logging in with your EduPage credentials, and watching it load. (It can take a little longer to load for the first time.)

Roadmap

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

Or the project board for a more organised list of upcoming features.

Contributing

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

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

  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

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contributors

Acknowledgements