Skip to content

Commit

Permalink
chore: document different development mode options
Browse files Browse the repository at this point in the history
  • Loading branch information
valeriansaliou committed Aug 16, 2023
1 parent 6cd0fbc commit d047e57
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,30 @@ npm run build

### Development target

#### Develop with release core (default)

To build Prose for a development environment (that is, a live development server streaming changes live), hit:

```
npm run dev
```

Note that if it is desired to build against a local `prose-core-client` containing a built `prose-sdk-js` package, you may pass a `PROSE_CORE_CLIENT_PATH` environment variable with the relative path to the core client library:
#### Develop with local core

If it is desired to build against a local `prose-core-client` containing a built `prose-sdk-js` package, you may pass a `PROSE_CORE_CLIENT_PATH` environment variable with the relative path to the core client library:

```
PROSE_CORE_CLIENT_PATH="../prose-core-client" npm run dev
```

On a second terminal, you may also watch for changes in the `prose-core-client` repository:

```
find crates bindings/prose-sdk-js/src Cargo.toml | entr -r cargo xtask wasm-pack build --dev
```

Any change happening in the core will trigger a compilation run, which itself will trigger a HMR event in the Web app (this may reload the whole app).

## Design

_👉 The Prose Web app reference design [can be found there](https://github.com/prose-im/prose-medley/blob/master/designs/app/prose-app-web.sketch)._
Expand Down

0 comments on commit d047e57

Please sign in to comment.