Kieran/snort
5
14
Fork 14
Code Issues 37 Pull Requests 1 Packages Projects Releases 24 Wiki Activity

add build command to readme

Browse Source
This commit is contained in:
Josh Remaley 2023-02-14 15:10:29 -06:00
parent 94bdd44192
commit 149c235cc3
No known key found for this signature in database
GPG Key ID: 1989BFE475E31D28
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -35,6 +35,20 @@ Snort supports the following NIP's:
### Running
This repository is a yarn workspace. To install dependencies, run `yarn` from the project root.
To build the `nostr` package, use either
```sh
$ yarn build
```
or, to automatically rebuild the `nostr` package if you are working on those files
```sh
$ cd packages/nostr
$ yarn watch
```
To run the application, use either
```sh
@ -47,3 +61,10 @@ or
$ cd packages/app
$ yarn start
```
The `nostr` package must be built (this produces a `packages/nostr/dist` folder) in order to run the main application (`packages/app`).
If you encounter the below error, it indicates that the `nostr` package has not been built:
```
Module not found: Error: Can't resolve '@snort/nostr'
```