feat: add NixOS flake development environment#21
Conversation
Add recommended Nix flake workflow for NixOS users, allowing them to quickly set up the development environment without manual system dependency installation. Maintain backward compatibility with manual setup instructions. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThe PR restructures project setup documentation and introduces a Nix-based development environment. README.md is reorganized to document both Nix ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
23-33:⚠️ Potential issue | 🟡 MinorResolve markdownlint MD014 in manual command blocks.
Line 26 and Line 32 use
$command prefixes without command output, which triggers the reported markdownlint warning. Consider removing$for consistency with the Nix section.Suggested doc fix
```bash -$ npm install +npm install@@
-$ npm run dev +npm run dev</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@README.mdaround lines 23 - 33, Update the README.md under the "Install" and
"Development" sections to remove the leading "$" from the fenced bash examples
so they are plain commands (change "$ npm install" to "npm install" and "$ npm
run dev" to "npm run dev") to resolve markdownlint MD014 and match the Nix
section formatting.</details> </blockquote></details> </blockquote></details>🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed. Outside diff comments: In `@README.md`: - Around line 23-33: Update the README.md under the "Install" and "Development" sections to remove the leading "$" from the fenced bash examples so they are plain commands (change "$ npm install" to "npm install" and "$ npm run dev" to "npm run dev") to resolve markdownlint MD014 and match the Nix section formatting.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID:
345c6530-819d-4671-b587-cbaf2b448e67⛔ Files ignored due to path filters (1)
flake.lockis excluded by!**/*.lock📒 Files selected for processing (2)
README.mdflake.nix
|
Closing this PR in favor of a more robust solution submitted on: #22 |
1 participant
Adds a
flake.nixandflake.lockfor reproducible development on NixOS. The shell provides Node.js and all system libraries required by Electron (GTK3, X11, Mesa, GBM, audio, etc.) viaLD_LIBRARY_PATH, so the app runs without manual dependency management.Usage
Supports
x86_64-linuxandaarch64-linux.Known issue
From my experience on Hyprland: in pet mode, if the avatar has been sitting idle and the user drags it using the window manager (e.g. via a move keybind or WM drag), the session crashes and logs you out. In-app drag (clicking and dragging the avatar directly) is unaffected. This appears to be a Wayland/Electron interaction issue and is not introduced by this PR.
Summary by CodeRabbit
Documentation
Chores