Skip to content

SDESK-4688: add npx link documentation for local development #2808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BrianMwangi21 merged 1 commit into from
Apr 21, 2026
+6 −5
Merged

SDESK-4688: add npx link documentation for local development #2808

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,15 @@ git clone git@github.com:superdesk/superdesk-planning.git
```

#### Client
Running the following will link the superdesk-planning module in development mode:
```
To link this package into a Superdesk client, use [`npx link`](https://github.com/privatenumber/link):

```sh
cd superdesk/client
npm install
npm link ../../superdesk-planning
cd ../..
npx link /path/to/superdesk-planning
```

A fresh `npm install` in the client will restore the published version.

#### Server
Run the following to install the python module in development mode:
```
Expand Down