From 04c7e16c8dcb585117eddf89a1dee9f9f42df8d5 Mon Sep 17 00:00:00 2001 From: David <93448496+Computerkrack@users.noreply.github.com> Date: Mon, 23 Sep 2024 22:28:22 +0200 Subject: [PATCH] Update README.md (#7) - Updated outdated links and optimized sentences. - Added a German translation --- README.de.md | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 55 ++++++++++++++-------------- 2 files changed, 128 insertions(+), 27 deletions(-) create mode 100644 README.de.md diff --git a/README.de.md b/README.de.md new file mode 100644 index 0000000..1082104 --- /dev/null +++ b/README.de.md @@ -0,0 +1,100 @@ +# Dlool + +[English README](./README.md) + +## Ein digitales und kollaboratives Hausaufgabenheft + +Dlool ist ein digitales und kollaboratives Hausaufgabenheft. +Klassische Hausaufgabenhefte haben eine Menge Probleme. Hier sind einige Probleme und wie Dlool sie löst: + +| Problem | Lösung | +| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Manche Schüler arbeiten nur digital, benutzen aber immer noch ein klassisches, analoges Hausaufgabenheft | Dlool ist digital und ein optimaler Ersatz. | +| Alle in einer Klasse schreiben die selben Hausaufgaben auf | Dlool ist kollaborativ, alle Einträge einer Klasse sind für alle verfügbar. | +| Nicht sehr gut für die Umwelt, da sie nach nur einem Schuljahr weggeworfen werden | Dlool ist digital, es wird kein Papier benötigt. | +| Sie sind nicht sehr praktisch | Dlool ist auf allen Geräten verfügbar. | +| Einträge sind nicht sehr strukturiert | Dlool hat ein strukturiertes System zum Eintragen von Hausaufgaben. | +| Wenn Du Dein Hausaufgabenheft verlierst, sind alle Deine Daten für immer verloren | Dlool ist digital, Du kannst es nicht verlieren. | +| Jedes Jahr braucht man ein neues Hausaufgabenheft | Dlool kann für mehrere Jahre verwendet werden. | +| Du bist an eine bestimmte Marke gebunden | Dlool ist kostenlos und quelloffen. *(Mit Dlool kanst Du Deine Daten in ical oder todo.txt exportieren. Außerdem gibt es [eine Möglichkeit](https://github.com/Dlurak/dlool-scriptable/blob/main/reminders/README.md), Dlool mit Apple Reminders zu synchronisieren.)* **(noch nicht implementiert)** | +| Hausaufgaben, Tests und Notizen sind nicht getrennt | Dlool hat ein anderes System für Hausaufgaben, Tests und Notizen. Alles ist getrennt organisiert, aber dennoch leicht an einem Ort zu finden. | + +--- + +## Features + +Dlool bietet eine Vielzahl von Funktionen, um Deine Hausaufgabenverwaltung zu erleichtern. + +- **Kollaborativ**: Alle Einträge aus einer Klasse sind für alle verfügbar. +- **Strukturiert**: Dlool hat ein strukturiertes Eingabesystem. Es ist einfach zu bedienen, aber auch sehr leistungsfähig. +- *(**Exportierbar**: Du kannst Deine Daten nach ical oder todo.txt exportieren, + mit [diesem](https://github.com/Dlurak/dlool-scriptable/blob/main/reminders/README.md) Skript kannst Du Dlool auch mit Apple Reminders synchronisieren.)* **(noch nicht implementiert)** +- **Plattformübergreifend**: Zugriff auf Dlool von allen Geräten mit einem Browser. +- **Dunkelmodus**: Dlool passt sich automatisch an Ihre Systemeinstellungen an. Dlool respektiert auch reduzierte Bewegungseinstellungen. +- **REST-API**: Es gibt eine offene REST-API, um eigene Skripte zu schreiben. +- **Kein Konto erforderlich**: Auch ohne Konto kannst Du Dlool nutzen. +- **Langfristige Nutzbarkeit**: Halte deine Daten über Jahre hinweg organisiert. +- **Moderationssystem**: Erhalte eine positive, einladende und sichere Umgebung aufrecht. +- **Notizen**: Schreib kurze Notizen für Dich oder Deine Klasse. +- **Kalender**: Behalte den Überblick über Tests und Fristen mit dem wunderschönen Kalender von Dlool. +- **Stundenplan**: Mit der Stundenplanunterstützung weißt Du ganz einfach, welche Fächer wann sind und kannst die Hausaufgaben richtig aufschreiben. +- **Feiertage**: Schaue nach, wann in Deiner Gegend Feiertage sind, die Daten werden von [der OpenHolidayAPI](https://www.openholidaysapi.org/en/) bereitgestellt + +- Viele kleine Dinge, die Dir das Leben leichter machen. + +--- + +## Technologien + +### Frontend + +Dlool ist eine progressive Webanwendung und baut auf den folgenden Technologien: + +- [SvelteKit](https://kit.svelte.dev/) +- [TailwindCSS](https://tailwindcss.com/) +- [Vercel](https://vercel.com/) + +### [Backend](https://github.com/Dlurak/dlool_backend_v2) + +Das [Backend](https://github.com/Dlurak/dlool_backend_v2) von Dlool baut auf den folgenden Technologien: + +- [Bun](https://bun.sh) +- [Elysia](https://elysiajs.com/) +- [EdgeDB](https://www.edgedb.com/) +- [Render](https://render.com/) + +--- + +## Erste Schritte + +Der einfachste Weg, Dlool auszuprobieren, ist ein Besuch auf [der offiziellen Website](https://dlool.me/). + +Wenn Du Dlool lokal ausführen möchten, z.B. für die Entwicklung, kannst Du [den Anweisungen](#Lokal-ausführen) unten folgen. + +Die Hausaufgaben sind für jeden öffentlich sichtbar, dies ist beabsichtigt, um Mobbing vorzubeugen. Wenn Du aber Hausaufgaben erstellen, aktualisieren oder löschen willst, brauchst Du einen Account für eine bestimmte Klasse. Du kannst einen Account [hier](https://dlool.me/register) erstellen. Es kann vorkommen, dass jemand aus Deiner Klasse bereits Dlool benutzt, dann muss er Deine Anfrage, sich für die Klasse anzumelden, akzeptieren. Dies kann man tun, indem man [diese Seite](https://www.dlool.me/moderation/list) besucht und auf die Schaltfläche „Akzeptieren“ klickt. + +Sobald Du Dein Konto hast, kannst Du Dich [hier](https://dlool.me/login) einloggen und eine Hausaufgabe [hier](https://dlool.me/homework/) erstellen. + +Wenn Du Fragen hast, einen Fehler findest oder eine Idee für eine Funktion hast, kannst Du ein [Issue](https://github.com/Dlurak/dlool_frontend_v2/issues) erstellen. + +## Lokal ausführen + +1. Klone dieses Repository + +```bash + git clone git@github.com:Dlurak/dlool_frontend_v2.git + ``` + +2. Führe das Setup-Skript aus + + ```bash + ./setup.sh + ``` + +3. Der Server läuft auf [localhost port 4173](http://localhost:4173) + +--- + +Gerne kannst Du Dich bei Fragen, Problemen oder Anregungen melden, indem Du ein Issue [hier](https://github.com/Dlurak/dlool_frontend_v2/issues) auf GitHub erstellen. + +Viel Erfolg und Spaß mit Dlool! diff --git a/README.md b/README.md index 050a23b..38d5a40 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # Dlool +[Deutsche README](./README.de.md) + ## A digital and collaborative homework book Dlool is a digital and collaborative homework book. -Classical homework books have a lot of problems. These are some of them and how Dlool solves them. - -| Problem | Solution | -| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Some students work only digitally but still use a classical, analog homework book | Dlool is digital and a highly optimized drop in replacement. | -| Everyone in a class writes down the same | Dlool is collaborative, all entries from one class are available for everyone | -| They are not very good for the environment, as it will be thrown away after just one year | Dlool is digital, no paper is needed. | -| They are not very practical | Dlool is available on all devices. | -| Entries are not very structured | Dlool has a structured entry system. | -| When you lose your homework book, all your data is lost forever | Dlool is digital, you can't lose it. | -| Every year you need a new homework book | Dlool can be used for multiple years. | -| You are locked into a specific brand | Dlool is free and open source. With Dlool you can export your data to ical or todo.txt. Also there is [a way](https://github.com/Dlurak/dlool-scriptable/blob/main/reminders/README.md) to sync Dlool with Apple Reminders. | -| Homework, tests and notes are not separate | Dlool has a different system for homework, tests and notes. Everything is separated but still in one place and easy to find. | +Classical homework books have a lot of problems. These are some of them and how Dlool solves them: + +| Problem | Solution | +| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Some students work only digitally but still use a classical, analog homework book | Dlool is digital and a highly optimized drop-in replacement. | +| Everyone in a class writes down the same homework | Dlool is collaborative, all entries from one class are available for everyone. | +| They are not environmentally friendly, as they are discarded after just one year | Dlool is digital, eliminating the need for paper. | +| They are not very practical | Dlool is available on all devices. | +| Entries are not very structured | Dlool has a structured system for entering homework. | +| If you lose your homework book, all your data is gone forever | Dlool is digital, you can't lose it. | +| Every year you need a new homework book | Dlool can be used for multiple years. | +| Traditional homework books lock you into a specific brand | Dlool is free and open source. *(With Dlool you can export your data to ical or todo.txt. Also, there is [a way](https://github.com/Dlurak/dlool-scriptable/blob/main/reminders/README.md) to sync Dlool with Apple Reminders.)* **(not yet implemented)** | +| Homework, tests and notes are not separate | Dlool offers a distinct system for homework, tests, and notes. Everything is separated but still in one place and easy to find. | --- @@ -24,19 +26,19 @@ Classical homework books have a lot of problems. These are some of them and how Dlool offers a lot of features to enhance your homework management experience. - **Collaborative**: All entries from one class are available for everyone. -- **Structured**: Dlool has a structured entry system. It is still easy to use but also very powerful. -- **Exportable**: You can export your data to ical or todo.txt, - using [this](https://github.com/Dlurak/dlool-scriptable/blob/main/reminders/README.md) script you can also sync Dlool with Apple Reminders. +- **Structured**: Dlool has a structured entry system. It is easy to use but also very powerful. +- *(**Exportable**: You can export your data to ical or todo.txt, + using [this](https://github.com/Dlurak/dlool-scriptable/blob/main/reminders/README.md) script, you can also sync Dlool with Apple Reminders.)* **(not yet implemented)** - **Cross-Platform**: Access Dlool on all devices with a browser. - **Dark mode**: Dlool automatically adapts to your system settings. Dlool also respects reduced motion settings. -- **REST API**: There is a open REST-API to write own scripts. -- **No Account required**: Even without an account you can use Dlool. +- **REST API**: There is an open REST-API to write own scripts. +- **No Account required**: Even without an account, you can use Dlool. - **Long-Term Usability**: Keep your data organized for years to come. - **Moderation system**: Maintain a positive, welcoming and safe environment. - **Notes**: Write short notes for yourself or your class. - **Calendar**: Keep track of tests and deadlines using Dlool's gorgeous calendar. - **Timetable**: Easily know which subjects are when and write down the homework correctly using the timetable support -- **Holidays**: Look up when holidays are in your area, the data is provided by [the OpenHolidayAPI](https://www.openholidaysapi.org/en/) +- **Holidays**: Check holidays in your area with data provided by [the OpenHolidayAPI](https://www.openholidaysapi.org/en/) - A lot of small things to make your life easier. --- @@ -51,9 +53,9 @@ Dlool is a progressive web app and is powered by the following technologies: - [TailwindCSS](https://tailwindcss.com/) - [Vercel](https://vercel.com/) -### Backend +### [Backend](https://github.com/Dlurak/dlool_backend_v2) -Dlool's backend is powered by the following technologies: +Dlool's [backend](https://github.com/Dlurak/dlool_backend_v2) is powered by the following technologies: - [Bun](https://bun.sh) - [Elysia](https://elysiajs.com/) @@ -64,13 +66,13 @@ Dlool's backend is powered by the following technologies: ## Getting started -The easiest way to try Dlool is to visit [the official deployment](https://dlool-frontend.vercel.app/). +The easiest way to try Dlool is to visit [the official deployment](https://dlool.me/). -If you want to run it locally e.g. for development you can follow the instructions below. +If you want to run it locally e.g. for development you can follow the instructions below ([[#Running locally]]). -Homework will be publicly visible for everyone, this isn't a bug but to prevent bullying. But if you want to create, update or delete homework you will need an account for a specific class. You can create one [here](https://dlool-frontend.vercel.app/register). It may happen that somebody from your class is already using Dlool, then they will need to accept your request to sign up for the class. This can be done by going to [this page](https://dlool-frontend.vercel.app/requests/list) and clicking on the accept button. +Homework will be publicly visible for everyone, this isn't a bug but to prevent bullying. However, if you want to create, update, or delete homework entries, you will need an account for a specific class. You can create one [here](https://dlool.me/register).If someone from your class is already using Dlool, then they will need to accept your request to sign up for the class. This can be done by going to [this page](https://dlool-frontend.vercel.app/requests/list) and clicking on the accept button. -Once you have your account you can login [here](https://dlool-frontend.vercel.app/login) and create a homework [here](https://dlool-frontend.vercel.app/homework/). You can also export your homework as ical [here](https://dlool-frontend.vercel.app/tricks#ical). +After creating your account you can login [here](https://dlool.me/login) and create a homework [here](https://dlool.me/homework/). When you have any questions, find a bug or have an idea for a feature you can create an issue. @@ -80,7 +82,6 @@ When you have any questions, find a bug or have an idea for a feature you can cr ```bash git clone git@github.com:Dlurak/dlool_frontend_v2.git - ``` 2. Run the setup script @@ -93,5 +94,5 @@ When you have any questions, find a bug or have an idea for a feature you can cr --- -Feel free to reach out, report issues, or share your ideas by creating an issue here on GitHub. +Feel free to reach out, report issues, or share your ideas by creating an issue [here](https://github.com/Dlurak/dlool_frontend_v2/issues) on GitHub. Enjoy using Dlool!