Notely

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

You can download & install Notely from either the App Store, Google Play Store or use it on the web.

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

(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

   git clone https://github.com/thilojaeggi/Notely.git
   

2. Get flutter packages

   flutter pub get
   

3. 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 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 GNU Affero General Public License v3.0. See LICENSE.md for more information.

(back to top)

Contact

Thilo Jaeggi - thilo@notely.ch

Project Link: https://github.com/thilojaeggi/Notely

(back to top)