Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dlurak/dloolfrontend

The frontend for a digital and collaborative homework book
https://github.com/dlurak/dloolfrontend

dlool frontend homework i18n internationalization pwa school svelte sveltekit

Last synced: 23 days ago
JSON representation

The frontend for a digital and collaborative homework book

Host: GitHub
URL: https://github.com/dlurak/dloolfrontend
Owner: Dlurak
License: gpl-2.0
Created: 2023-07-28T09:03:29.000Z (over 1 year ago)
Default Branch: Main
Last Pushed: 2024-04-17T14:21:51.000Z (9 months ago)
Last Synced: 2024-04-24T09:19:50.240Z (9 months ago)
Topics: dlool, frontend, homework, i18n, internationalization, pwa, school, svelte, sveltekit
Language: Svelte
Homepage: https://dlool.me
Size: 1.8 MB
Stars: 4
Watchers: 1
Forks: 2
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Dlool

## A digital and collaborative homework book

**THE API AND ALSO THIS FRONTEND WAS FULLY REBUILD.**

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

---

## Features

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.
- **Cross-Platform**: Access Dlool on all devices with a browser.
- **Offline Support**: Most of Dlool works offline, so you can even use it in schools with bad or no internet. **This is currently broken!**
- **Dark mode**: Dlool automatically adapts to your system settings. Dlool also respects reduced motion settings.
- **REST API**: Extensive and well [documented](https://dlurak.github.io/dloolBackend/) REST API to write your 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/)
- A lot of small things to make your life easier.

---

## Technologies

### Frontend

Dlool is a progressive web app and is powered by the following technologies:

- [SvelteKit](https://kit.svelte.dev/)
- [TailwindCSS](https://tailwindcss.com/)
- [Vercel](https://vercel.com/)
- [Boxicons](https://boxicons.com/)

### Backend

Dlool's backend is powered by the following technologies:

- [Node.js](https://nodejs.org/)
- [Express](https://expressjs.com/)
- [MongoDB](https://www.mongodb.com/)
- [Render](https://render.com/)

---

## Getting started

The easiest way to try Dlool is to visit [the official deployment](https://dlool-frontend.vercel.app/).

If you want to run it locally e.g. for development you can follow the instructions below.

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.

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).

When you have any questions, find a bug or have an idea for a feature you can create an issue.

## Running locally

1. Clone this repository

```bash
git clone [email protected]:Dlurak/dloolFrontend.git
```

2. Install the dependencies

```bash
pnpm install
```

3. Build from source

```bash
pnpm run build
```

4. Start the server

```bash
pnpm run preview
```

5. The server runs on [localhost port 4173](http://localhost:4173)

For full functionality, ensure you set up the backend as well. Detailed backend setup instructions can be found here. Don't forget to create a `.env` file in the frontend's root directory with this variable:

| Variable | Recommended value | Description |
| -------------- | ------------------------------------------------- | ---------------------------------------------------------- |
| PUBLIC_API_URL | PUBLIC_API_URL=https://dlool-backend.onrender.com | The URL of the backend. **Do not put a slash at the end!** |

You can create the `.env` file with this command:

```bash
echo "PUBLIC_API_URL=https://dlool-backend.onrender.com" > .env
```

## License

Every of mine repositories for Dlool is licensed under the [GPL](/LICENSE).

---

Feel free to reach out, report issues, or share your ideas by creating an issue here on GitHub.
Enjoy using Dlool!