Skip to content

Latest commit

 

History

History
180 lines (117 loc) · 5.66 KB

README.md

File metadata and controls

180 lines (117 loc) · 5.66 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

School Planner - Homework & Timetable

In this repository we collaborate to build the perfect school planner. And you can help us.
Explore the docs »

Download · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

What makes the app special?

It's the upgrade for your school day. From now on, you no longer have to tediously enter your homework and timetable alone. The school planner connects you with all your classmates. If someone enters his or her homework, it is immediately available to all the others. So you'll never forget your homework again!

Built With

Getting Started

Structure

  • app: This is the app itself, a cross-platform project based on flutter.
  • cloud_functions: Scripts that handle the server-side functions of the app.
  • packages: Outsourced Flutter Packages from /app. By moving functions to /packages, we can achieve a tidier code base.
  • schulplaner_website: The official website.
  • web_app: Temporary only, this is where the web version of /app is saved and finally uploaded.
  • utils: The vacation databases in JSON format.
  • security_rules: Security rules for Google's Firestore and Firebase



To get a local copy up and running follow these simple steps.

Installation

  1. Clone the repo 
    git clone https://github.com/flowhorn/schulplaner.git
  2. Read our Wiki-entry on how to run the app

Usage

TODO

Roadmap

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

Contributing

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

  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.

Contact

Since Felix has little time besides his studies, the community discord and Henrik are the fastest ways to get in touch with the school planner team.

Project Link: https://github.com/flowhorn/schulplaner

Acknowledgements