schulplaner

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #go #android #machine-learning #deep-learning #docker #java #awesome #kubernetes #vue #openai

(★ 34)

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

schulplaner Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![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]

<br />
<p align="center">
  <a href="https://github.com/flowhorn/schulplaner">
    <img src="https://cdn.discordapp.com/icons/539058965061828608/5328f1f1c84b3fbcba3bcbab945e48e5.png" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">School Planner - Homework & Timetable</h3>

<p align="center">
    In this repository we collaborate to build the perfect school planner. And you can help us.
    <br />
    <a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://schulplaner.web.app/">Download</a>
    ·
    <a href="https://github.com/flowhorn/schulplaner/issues">Report Bug</a>
    ·
    <a href="https://github.com/flowhorn/schulplaner/issues">Request Feature</a>
  </p>
</p>

<details open="open">
  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgements">Acknowledgements</a></li>
  </ol>
</details>

## 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

* [flutter](https://flutter.dev/)
* [Material Design](https://material.io/)

## 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
   ```sh
   git clone https://github.com/flowhorn/schulplaner.git
   ```
2. Read our [Wiki-entry on how to run the app](https://github.com/flowhorn/schulplaner/wiki/Run-the-App)

## Usage
#### TODO

<!-- Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_
-->

## Roadmap

See the [open issues](https://github.com/flowhorn/schulplaner/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.

- [Community Discord](https://schulplaner.pro/discord)

- Felix Weuthen, App-Founder: danielfelixplay@gmail.com
- Henrik Steffens, Developer: hey@th3ph4nt0m.de

Project Link: [https://github.com/flowhorn/schulplaner](https://github.com/flowhorn/schulplaner)

## Acknowledgements

* [Img Shields](https://shields.io)

[contributors-shield]: https://img.shields.io/github/contributors/flowhorn/schulplaner.svg?style=for-the-badge
[contributors-url]: https://github.com/flowhorn/schulplaner/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/flowhorn/schulplaner.svg?style=for-the-badge
[forks-url]: https://github.com/flowhorn/schulplaner/network/members
[stars-shield]: https://img.shields.io/github/stars/flowhorn/schulplaner.svg?style=for-the-badge
[stars-url]: https://github.com/flowhorn/schulplaner/stargazers
[issues-shield]: https://img.shields.io/github/issues/flowhorn/schulplaner.svg?style=for-the-badge
[issues-url]: https://github.com/flowhorn/schulplaner/issues
[license-shield]: https://img.shields.io/github/license/flowhorn/schulplaner.svg?style=for-the-badge
[license-url]: https://github.com/flowhorn/schulplaner/blob/master/LICENSE
[product-screenshot]: https://schulplaner.firebaseapp.com/img/screenshots/screen7.png

schulplaner

schulplaner Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

schulplaner

schulplaner Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README