Notely

A cross-platform mobile client for the Kaschuso (schulnetz) School platform.
· Report Bug · Request Feature

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url]

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact

You can download & install Notely from either the App Store, Google Play Store or F-Droid.

## About The Project Notely is a cross-platform app for the commonly used swiss school platform "Schulnetz" which allows you to see your grades, timetable and absences. It's currently only compatible with schools within the canton of Solothurn. (KSSO, GIBS, KBS, etc..)

(back to top)

### Built With * [![Flutter][Flutter]][Flutter-url] * [![Dart][Dart]][Dart-url] * [![Swift][Swift]][Swift-url]

(back to top)

## Getting Started To get a local copy up and running follow these simple steps. ### Prerequisites Flutter and Dart need to be installed. ### Installation 1. Clone the repo ```sh git clone https://github.com/thilojaeggi/Notely.git ``` 3. Get flutter packages ``` flutter pub get ``` 4. Build ``` flutter build apk ``` or ``` flutter build ipa ```

(back to top)

## Usage On the login screen select your school, enter your credentails and tap "Log in". That's it.

(back to top)

## Roadmap - [x] Notifications - [X] Add Homework - [ ] Widget (WIP) See the [open issues](https://github.com/thilojaeggi/Notely/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 MIT License. See `LICENSE.md` for more information.

(back to top)

## Contact Thilo Jaeggi - thiloj@protonmail.ch Project Link: [https://github.com/thilojaeggi/Notely](https://github.com/thilojaeggi/Notely)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/thilojaeggi/Notely.svg?style=flat-square [contributors-url]: https://github.com/thilojaeggi/Notely/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/thilojaeggi/Notely.svg?style=flat-square [forks-url]: https://github.com/thilojaeggi/Notely/network/members [stars-shield]: https://img.shields.io/github/stars/thilojaeggi/Notely.svg?style=flat-square [stars-url]: https://github.com/thilojaeggi/Notely/stargazers [issues-shield]: https://img.shields.io/github/issues/thilojaeggi/Notely.svg?style=flat-square [issues-url]: https://github.com/thilojaeggi/Notely/issues [license-shield]: https://img.shields.io/github/license/thilojaeggi/Notely.svg?style=flat-square [license-url]: https://github.com/thilojaeggi/Notely/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/linkedin_username [product-screenshot]: images/screenshot.png [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white [Next-url]: https://nextjs.org/ [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB [React-url]: https://reactjs.org/ [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D [Vue-url]: https://vuejs.org/ [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white [Angular-url]: https://angular.io/ [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00 [Svelte-url]: https://svelte.dev/ [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white [Laravel-url]: https://laravel.com [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white [Bootstrap-url]: https://getbootstrap.com [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white [JQuery-url]: https://jquery.com [Flutter]: https://img.shields.io/badge/Flutter-%2302569B.svg?style=for-the-badge&logo=Flutter&logoColor=white [Flutter-url]: https://flutter.dev [Dart]: https://img.shields.io/badge/dart-%230175C2.svg?style=for-the-badge&logo=dart&logoColor=white [Dart-url]: https://dart.dev [Swift]: https://img.shields.io/badge/swift-F54A2A?style=for-the-badge&logo=swift&logoColor=white [Swift-url]: https://www.swift.org/

excellent projects related to thilojaeggi/notely recommend downloading