Development Setup
Get your development environment ready for contributing to Fern Shell.
Prerequisites
- Nix with flakes enabled
- Hyprland compositor
- A code editor with QML support (recommended: VS Code with QML extension)
Clone and Enter Dev Shell
git clone https://github.com/adanoelle/fern-shell
cd fern-shell
nix develop
The dev shell provides:
- QuickShell for running QML
- Qt6 development tools
- Rust toolchain for fernctl
- mdbook for documentation
- Formatting tools (nixfmt, rustfmt)
Running the Shell
# Live preview with hot-reload
qs -p fern/shell.qml
Edit any QML file and save - changes appear immediately.
Building
# Build fernctl (Rust CLI)
cargo build -p fernctl
# Build everything via Nix
nix build
# Run CI checks locally
nix flake check
Project Structure
fern-shell/
├── fern/ # QML frontend
├── fernctl/ # Rust backend (CLI)
├── book/ # Documentation (mdbook)
├── flake-parts/ # Nix modules
└── tests/ # Test infrastructure
Next Steps
- Architecture - Understand the system design
- Adding Modules - Create a new bar module
- Rust Services - Build backend integrations
- Testing - Test patterns and CI