1
0
mirror of https://github.com/wulkanowy/wulkanowy.git synced 2024-11-09 22:20:52 -06:00
wulkanowy-mirror/README.en.md

66 lines
2.8 KiB
Markdown
Raw Normal View History

2019-07-17 06:41:47 -05:00
[Polska wersja README](README.md)
# Wulkanowy
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/wulkanowy/wulkanowy/Test%20and%20deploy/develop?style=flat-square)](https://github.com/wulkanowy/wulkanowy/actions)
2019-07-17 06:41:47 -05:00
[![Codecov](https://img.shields.io/codecov/c/github/wulkanowy/wulkanowy/master.svg?style=flat-square)](https://codecov.io/gh/wulkanowy/wulkanowy)
[![Discord](https://img.shields.io/discord/390889354199040011.svg?style=flat-square)](https://discord.gg/vccAQBr)
2019-10-01 15:19:28 -05:00
[![F-Droid](https://img.shields.io/f-droid/v/io.github.wulkanowy.svg?style=flat-square)](https://f-droid.org/packages/io.github.wulkanowy/)
[![Last release](https://img.shields.io/github/release/wulkanowy/wulkanowy.svg?logo=github&style=flat-square)](https://github.com/wulkanowy/wulkanowy/releases)
2019-07-17 06:41:47 -05:00
2020-01-03 14:12:05 -06:00
Unofficial android VULCAN UONET+ register client for both students and their parents
2019-07-17 06:41:47 -05:00
## Features
2020-01-03 14:12:05 -06:00
* logging in using the email and password OR using token and pin
2019-07-17 06:41:47 -05:00
* functions from the register website:
* grades
* grade statistics
* attendance
* percentage of attendance
* exams
* timetable
* completed lessons
* messages
* homework
* notes
* lucky number
2020-01-03 14:12:05 -06:00
* calculation of the average independently of school's preferences
2019-07-17 06:41:47 -05:00
* notifications, e.g. about a new grade
* dark and black (AMOLED) theme
* offline mode
* no ads
## Download
2020-10-07 04:19:34 -05:00
You can download the current beta version from the Google Play, F-Droid or Huawei AppGallery store
2019-07-17 06:41:47 -05:00
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
2020-10-07 04:19:34 -05:00
alt="Get it on Google Play"
height="80">](https://play.google.com/store/apps/details?id=io.github.wulkanowy)
2019-07-17 06:41:47 -05:00
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
2020-01-03 14:12:05 -06:00
alt="Get it on F-Droid"
2019-07-17 06:41:47 -05:00
height="80">](https://f-droid.org/packages/io.github.wulkanowy/)
2020-10-07 04:19:34 -05:00
[<img src="appgallery_badge.png"
alt="Explore it on AppGallery"
height="80">](https://appgallery.cloud.huawei.com/ag/n/app/C101440411?channelId=Badge&id=1b3f7fbb700849a9be0dba6b520b2282&s=EB1D3BF9ED9D1564D869B7B94B18016D3CABFCA5AEFB8E29F675FA04E0DC131D&detailType=0&v=)
2019-07-17 06:41:47 -05:00
2020-01-03 14:12:05 -06:00
You can also download a [development version](https://wulkanowy.github.io/#download) that includes new features being prepared for the next release
2019-07-17 06:41:47 -05:00
## Built With
* [Wulkanowy SDK](https://github.com/wulkanowy/sdk)
* [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
* [Hilt](https://dagger.dev/hilt/)
2019-07-17 06:41:47 -05:00
* [Room](https://developer.android.com/topic/libraries/architecture/room)
* [WorkManager](https://developer.android.com/topic/libraries/architecture/workmanager)
## Contributing
Please contribute to the project either by creating a PR or submitting an issue on GitHub.
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details