From 56fb9ec2c4a7af3dd19ae9240ed5db2cc8f22c83 Mon Sep 17 00:00:00 2001 From: Corentin Thomasset Date: Wed, 25 Jun 2025 13:37:12 +0200 Subject: [PATCH] docs(CONTRIBUTING): update dev instructions with package build step (#382) --- CONTRIBUTING.md | 14 +++++++++++--- package.json | 3 ++- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba18c64..83bf3d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,7 +84,15 @@ We recommend running the app locally for development. Follow these steps: pnpm install ``` -3. Start the development server for the backend: +3. Build the monorepo packages: + + As the apps rely on internal packages, you need to build them first. + + ```bash + pnpm build:packages + ``` + +4. Start the development server for the backend: ```bash cd apps/papra-server @@ -94,7 +102,7 @@ We recommend running the app locally for development. Follow these steps: pnpm dev ``` -4. Start the frontend: +5. Start the frontend: ```bash cd apps/papra-client @@ -102,7 +110,7 @@ We recommend running the app locally for development. Follow these steps: pnpm dev ``` -5. Open your browser and navigate to `http://localhost:3000`. +6. Open your browser and navigate to `http://localhost:3000`. ### Testing diff --git a/package.json b/package.json index 1875f79..8b1e656 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,8 @@ "docker:build:root": "docker build -t papra -f docker/Dockerfile .", "docker:build:rootless": "docker build -t papra-rootless -f docker/Dockerfile.rootless .", "version": "changeset version && pnpm install --no-frozen-lockfile", - "changeset": "changeset" + "changeset": "changeset", + "build:packages": "pnpm --filter './packages/*' --stream build" }, "devDependencies": { "@changesets/changelog-github": "^0.5.1",