Skip to content

Commit

Permalink
Merge branch 'master' into data-management-rewrite
Browse files Browse the repository at this point in the history
  • Loading branch information
vyPal authored Dec 28, 2023
2 parents cecdca8 + dcc2c01 commit 0633ea7
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 15 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@

[![test-coverage](https://github.com/DislikesSchool/EduPage2/actions/workflows/test-coverage.yml/badge.svg)](https://github.com/DislikesSchool/EduPage2/actions/workflows/test-coverage.yml)
[![build-patch-android](https://github.com/DislikesSchool/EduPage2/actions/workflows/build-patch.yml/badge.svg)](https://github.com/DislikesSchool/EduPage2/actions/workflows/build-patch.yml)

## Table Of Contents

- [Table Of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Backend Status](#backend-status)
- [Quick status](#quick-status)
- [Statuspage](#statuspage)
- [Disclaimer](#disclaimer)
- [Built With](#built-with)
- [Getting Started](#getting-started)
Expand All @@ -46,6 +48,15 @@ And that's why we made EduPage2. So far, EduPage2 lacks a pretty big amount of f

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](https://uptime.betterstack.com/status-badges/v1/monitor/w8hv.svg)](https://uptime.betterstack.com/?utm_source=status_badge) |
| Deta.space | [![Better Stack Badge](https://uptime.betterstack.com/status-badges/v1/monitor/wt8i.svg)](https://uptime.betterstack.com/?utm_source=status_badge) |
### Statuspage
Currently there are two status pages for the EduPage2 backend. The one on [Better Stack](https://ep2.betteruptime.com/) which we have confirmed to work, and the other one on [Statuspage](https://edupage2.statuspage.io/) 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.
Expand All @@ -58,13 +69,12 @@ This project is open source and distributed under the [GPL-3.0 license](https://

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

- [Flutter](https://flutter.dev/)
- [Firebase](https://firebase.google.com/)
- [OneSignal](https://onesignal.com/)
- [Flutter](https://flutter.dev/)
- [Express.js](https://expressjs.com/)
- [PlanetScale](https://planetscale.com/)
- [Passport.js](https://www.passportjs.org/)
- [Shorebird](https://shorebird.dev/)
- [Golang](https://go.dev/)
- [Gin](https://gin-gonic.com/)

## Getting Started

Expand Down
24 changes: 14 additions & 10 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,29 @@

### App versions

| Version | API | Supported | Remote patching \* | Changelog |
| Version | API | Supported | Remote patches \* | Changelog |
| ------------- | --- | ------------------ | ------------------ | ----------------------------------------------------------------------------------- |
| > 1.7.3 | β13 | :white_check_mark: | :white_check_mark: | [1.7.3...1.7.6](https://github.com/DislikesSchool/EduPage2/compare/v1.7.1...v1.7.3) |
| 1.7.1 - 1.7.3 | β13 | :white_check_mark: | :x: | [1.7.1...1.7.3](https://github.com/DislikesSchool/EduPage2/compare/v1.7.1...v1.7.3) |
| 1.7.1 | β13 | :white_check_mark: | :x: | [1.7.0...1.7.1](https://github.com/DislikesSchool/EduPage2/compare/v1.7.0...v1.7.1) |
| 1.7.0 | β12 | :warning: | :x: | [1.6.0...1.7.0](https://github.com/DislikesSchool/EduPage2/compare/v1.6.0...v1.7.0) |
| 1.6.0 | β12 | :warning: | :x: | [1.5.2...1.6.0](https://github.com/DislikesSchool/EduPage2/compare/v1.5.2...v1.6.0) |
| 1.8.2 | v1 | :white_check_mark: | :white_check_mark: | [1.8.0...1.8.2](https://github.com/DislikesSchool/EduPage2/compare/v1.8.0...v1.8.2) |
| 1.8.0 | β14 | :x: | :white_check_mark: | [1.7.9...1.8.0](https://github.com/DislikesSchool/EduPage2/compare/v1.7.9...v1.8.0) |
| 1.7.3 - 1.7.9 | β13 | :x: | :white_check_mark: | [1.7.3...1.7.9](https://github.com/DislikesSchool/EduPage2/compare/v1.7.1...v1.7.9) |
| 1.7.1 - 1.7.3 | β13 | :x: | :x: | [1.7.1...1.7.3](https://github.com/DislikesSchool/EduPage2/compare/v1.7.1...v1.7.3) |
| 1.7.1 | β13 | :x: | :x: | [1.7.0...1.7.1](https://github.com/DislikesSchool/EduPage2/compare/v1.7.0...v1.7.1) |
| 1.7.0 | β12 | :x: | :x: | [1.6.0...1.7.0](https://github.com/DislikesSchool/EduPage2/compare/v1.6.0...v1.7.0) |
| 1.6.0 | β12 | :x: | :x: | [1.5.2...1.6.0](https://github.com/DislikesSchool/EduPage2/compare/v1.5.2...v1.6.0) |
| 1.5.x | β11 | :x: | :x: | [1.5.0...1.5.2](https://github.com/DislikesSchool/EduPage2/compare/v1.5.0...v1.5.2) |
| < 1.5 | | :x: | :x: | |

\* Remote patching allows us to quickly push patches and bug fixes directly to your device without you having to redownload the app
\* Remote patches allow us to quickly push patches and bug fixes directly to your device without you having to redownload the app

### API version

| Version | Supported | New features in version |
| ------- | ------------------ | ----------------------- |
| β13 | :white_check_mark: | |
| β12 | :warning: | |
| β11 | :warning: | iCanteen setup |
| v1 | :white_check_mark: | Complete rewrite |
| β14 | :x: | |
| β13 | :x: | |
| β12 | :x: | |
| β11 | :x: | iCanteen setup |
| < β11 | :x: | |

:white_check_mark: - Version running on server
Expand Down

0 comments on commit 0633ea7

Please sign in to comment.