fix: update .env.example, remove package-lock.json, add Windows dev notes
Some checks failed
Refresh Lockfile / refresh (push) Has been cancelled
Release / verify_canary (push) Has been cancelled
Release / publish_canary (push) Has been cancelled
Release / verify_stable (push) Has been cancelled
Release / preview_stable (push) Has been cancelled
Release / publish_stable (push) Has been cancelled

- Updated .env.example to match actual env vars (PAPERCLIP_PUBLIC_URL, BETTER_AUTH_SECRET)
- Added package-lock.json and VissSoft_CEO/ to .gitignore
- Added Windows development notes section in doc/DEVELOPING.md
This commit is contained in:
Hanh To
2026-03-20 23:10:51 +07:00
parent 035cb8aec2
commit fcb0846ab8
3 changed files with 39 additions and 2 deletions

View File

@@ -1,3 +1,14 @@
DATABASE_URL=postgres://paperclip:paperclip@localhost:5432/paperclip
# === Dev local (không cần DATABASE_URL, server dùng embedded PGlite) ===
# DATABASE_URL=postgres://paperclip:paperclip@localhost:5432/paperclip
# Server
PORT=3100
SERVE_UI=false
SERVE_UI=true
# Auth (bắt buộc cho authenticated mode)
PAPERCLIP_PUBLIC_URL=http://localhost:3100
BETTER_AUTH_SECRET=dev-secret-change-me-please-replace
# Agent API keys (optional)
# OPENAI_API_KEY=sk-...
# ANTHROPIC_API_KEY=sk-ant-...

2
.gitignore vendored
View File

@@ -11,6 +11,8 @@ data/
.pnpm-store/
tmp-*
cli/tmp/
package-lock.json
VissSoft_CEO/
# Scratch/seed scripts (but not scripts/ dir)
check-*.mjs

View File

@@ -15,6 +15,30 @@ Current implementation status:
- Node.js 20+
- pnpm 9+
## Windows Development Notes
The project runs on Windows with a few adjustments:
**Install pnpm via corepack (bundled with Node.js 20+):**
```powershell
corepack enable
corepack prepare pnpm@9.15.4 --activate
```
**Shell command equivalents:**
| Linux/macOS | Windows (PowerShell) |
|---|---|
| `rm -rf ~/.paperclip/instances/default/db` | `Remove-Item -Recurse -Force "$env:USERPROFILE\.paperclip\instances\default\db"` |
| `export DATABASE_URL=...` | `$env:DATABASE_URL = "..."` |
| `curl http://localhost:3100/api/health` | `Invoke-RestMethod http://localhost:3100/api/health` |
**Notes:**
- Shell scripts (`.sh`) under `scripts/` require Git Bash or WSL. Most common dev commands (`pnpm dev`, `pnpm build`, `pnpm typecheck`, `pnpm test:run`) work natively in PowerShell.
- Data paths use `%USERPROFILE%\.paperclip\` instead of `~/.paperclip/`.
- If using Docker Desktop for Windows, ensure WSL 2 backend is enabled.
## Dependency Lockfile Policy
GitHub Actions owns `pnpm-lock.yaml`.