Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Thank you for considering a contribution to Arkloop. This document covers the pr
- Docker and Docker Compose
- PostgreSQL 16+ (or use `docker compose up postgres`)

Alternatively, if you use Nix with flakes enabled, enter the pinned development shell:

```bash
nix develop
```

The flake provides Go 1.26, Node.js, Corepack-managed pnpm, Docker Compose, PostgreSQL/Redis clients, and the local CI helper dependencies. Docker still needs a running host daemon.

### Local Development Setup

```bash
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ Homebrew installs the Arkloop CLI only:
brew install qqqqqf-q/arkloop/arkloop && ark web
```

### Desktop via Nix

Linux users with flakes enabled can run or install the desktop app from the flake:

```bash
nix run github:qqqqqf-q/Arkloop
nix profile install github:qqqqqf-q/Arkloop
```

For a headless Linux machine, use one command:

```bash
Expand Down
27 changes: 27 additions & 0 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading