SharezoneApp/sharezone-app

Sharezone Banner with two phones

Download Sharezone

Android	iOS	macOS	Web
Get Sharezone on Google Play	Get Sharezone for iOS	Get Sharezone for macOS	Open the Sharezone web app

Sharezone is a collaborative school organization app for iOS, Android, macOS and web.
With Sharezone pupils, teachers and even parents can use the following features together as a class:

• 📚 Homework diary
• 🕒 Timetable
• 📅 Calendar
• 💬 Information sheets
• 📁 Files
• ⭐️ Grades (not shared with the class)

Sharezone is currently only available in German.
We might expand to more languages and regions in the future 🌍🚀

Join our Discord for active discussions, announcements, feedback and more!

Repository Overview

• 🛠 .github/: Our fully automated CI/CD pipeline using GitHub Actions and codemagic-cli-tools. Used to publish alpha, beta, and stable versions to Google Play Store (Android), App Store (iOS, macOS), TestFlight (iOS, macOS), and Firebase Hosting (Web).

• 📱 app/: The main "Sharezone" app, created with Flutter.

• 📚 lib/: A place for our internal Dart/Flutter packages. Used to modularize and share code between app, website and admin console.

• 📖 docs/: Our end user documentation docs.sharezone.net, built with Nextra. Is currently pretty sparse, but we are working on improving it.

• 🌐 website/: Our sharezone.net website (not the web app) built with Flutter.

• 🔧 console/: Our admin console used by the Sharezone team for support / administrative tasks. Also built with Flutter.

• 🛠️ tools/sz_repo_cli/: Our custom sz Dart CLI used by developers and CI/CD pipelines. Helps with tasks like testing, analyzing, building, deploying etc.

Running the app

To run the app locally, please read the instructions in our CONTRIBUTING.md.

Tests

We use several types of tests to ensure the quality and stability of Sharezone:

• Unit Tests: Verify the logic of individual functions or classes in isolation.
• Widget Tests: Test widgets’ UI and interaction behavior without running the full app.
• Golden Tests: Compare rendered widgets to “golden” reference images to detect unintended visual changes.
• Integration Tests: Run the app on a device or emulator to test end-to-end flows.

To run the tests, please read the instructions in our CONTRIBUTING.md.

Open-Source

This project is licensed under EUPL v1.2 or later.
For some files other licenses or terms (regarding e.g. copyright) might apply. This can be indicated, for example, by a notice included in the file itself or a README in a parent folder.
Guidelines for users and developers for the EUPL v1.2 can be found here.

Contribute

To contribute just open a PR and sign the Contributor License Agreement.
A bot will automatically ask you to accept the CLA when a PR is opened if you haven't already.

We have more instructions to help you get started in the CONTRIBUTING.md.

Follow us

• Instagram
• Twitter
• Discord