@lightupai/polaris 0.0.49 → 0.0.50
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,6 +11,31 @@ Multiplayer collaboration for AI coding agents. Connects coding sessions (Claude
|
|
|
11
11
|
- **Slack Bridge** (`src/slack/bridge.ts`) — Bidirectional bridge between project event streams and Slack channels.
|
|
12
12
|
- **Hooks** (`hooks/`) — Shell scripts that capture coding agent interactions (prompts, responses, tool calls).
|
|
13
13
|
|
|
14
|
+
## Prerequisites
|
|
15
|
+
|
|
16
|
+
Install these before running the Quick Start:
|
|
17
|
+
|
|
18
|
+
| Tool | Why | Install |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| [Bun](https://bun.sh) | Runtime for all services, the CLI, and the test suite | `npm install -g bun`, `brew install oven-sh/bun/bun`, or `curl -fsSL https://bun.sh/install \| bash` |
|
|
21
|
+
| [Docker](https://docs.docker.com/get-docker/) | Runs the Postgres container | Docker Desktop (macOS/Windows) or Docker Engine (Linux) — must be **running** |
|
|
22
|
+
|
|
23
|
+
Then verify:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
bun --version # 1.x
|
|
27
|
+
docker info # should succeed (daemon running)
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
> **Port 5432 must be free.** `docker compose up -d` binds Postgres to `5432`. If another
|
|
31
|
+
> Postgres already uses that port, either stop it, or run the container on `5433` and set
|
|
32
|
+
> `DATABASE_URL=postgres://polaris:polaris@127.0.0.1:5433/polaris` (and pass the same
|
|
33
|
+
> `DATABASE_URL` to `make test`, pointing at the `polaris_test` database).
|
|
34
|
+
|
|
35
|
+
> **Login needs Google OAuth.** `make dev` and `polaris login` authenticate via Google SSO,
|
|
36
|
+
> so `GOOGLE_CLIENT_ID` / `GOOGLE_CLIENT_SECRET` must be set in `.env` (see
|
|
37
|
+
> [Configuration](#configuration)). The test suite (`make test`) does **not** require this.
|
|
38
|
+
|
|
14
39
|
## Quick Start
|
|
15
40
|
|
|
16
41
|
```sh
|