jappeos_greeter

The login screen for JappeOS.

---

Overview

The login screen for JappeOS, written in Flutter.

Features

• Initial user creation
• User selection
• User login
• Power management

Role in the OS

Usually the first UI the user sees after booting their system.

Building

Prerequisites

• Flutter SDK 3.38.0 or later (with desktop support enabled)
• Dart SDK (included with Flutter)

Verify Flutter desktop setup:

$ flutter doctor

Setup

Clone the repository and fetch dependencies:

$ git clone https://github.com/JappeOS/jappeos_greeter.git
$ cd jappeos_greeter
$ flutter pub get

Build

Linux

Read build instructions at the end of this file: https://github.com/JappeOS/jdwm/blob/main/_integration_kit/DEPENDENCY_README.md

Important

JDWM is already a dependecy of this project. You might still need to install wlroots and the correct version of Flutter into the vendor/* directory. After that, you should be ready to build.

Other platforms

The JDWM compositor is not supposed to work on other platforms than Linux. Support or usability for other platforms cannot be guaranteed.

Troubleshooting

If the build fails after dependency changes or Docker image deletion, simply run ./run_build.sh build-image as instructed in the DEPENDENCY_README.md file linked above. If the JDWM native code is modified, a clean build is required. Simply update the JDWM GIT submodule to update JDWM, then run a clean build, as instructed in DEPENDENCY_README.md.

Contributing

Contributions of all kinds are welcome and appreciated. You can help the project by:

• ⭐ Starring the repository to show your support
• 💖 Sponsoring the project (if available)
• 🐞 Reporting bugs via GitHub Issues
• 💡 Requesting or discussing new features

For code contributions, please see CONTRIBUTING.md for guidelines.

License

This repository is part of the JappeOS project and is licensed under the terms described in the LICENSE file.