highperfocused/nostream
1
0
Fork 0
mirror of https://github.com/Cameri/nostream.git synced 2025-03-17 21:31:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify getting started steps

Browse Source
This commit is contained in:
Ricardo Arturo Cabral Mejia 2022-11-06 01:25:36 -04:00
parent 53c22ed273
commit 4789295905
No known key found for this signature in database
GPG Key ID: 5931EBF43A650245
1 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -58,12 +58,21 @@ NIPs with a relay-specific implementation are listed here.
## Quick Start (Docker Compose) (Best)
Start with:
Install Docker following the [official guide](https://docs.docker.com/engine/install/).
You may have to uninstall Docker if you installed it using a different guide.
Clone repository and enter directory:
```
git clone git@github.com:Cameri/nostr-ts-relay.git
cd nostr-ts-relay
```
Start with:
```
npm run docker:compose:start &
```
Stop the server with:
Stop the server with:
```
npm run docker:compose:stop
```
@ -88,6 +97,12 @@ Create `nostr_ts_relay` database:
postgres=# quit
```
Clone repository and enter directory:
```
git clone git@github.com:Cameri/nostr-ts-relay.git
cd nostr-ts-relay
```
Install dependencies:
```
@ -128,6 +143,11 @@ To clean up the build, coverage and test reports run:
### Unit tests
Open a terminal and change to the project's directory:
```
cd /path/to/nostr-ts-relay
```
Run unit tests with:
```
@ -158,6 +178,11 @@ To see the unit tests coverage report open `.coverage/unit/lcov-report/index.htm
### Integration tests (Docker Compose)
Open a terminal and change to the project's directory:
```
cd /path/to/nostr-ts-relay
```
Run integration tests with:
```
@ -172,6 +197,11 @@ And to get integration test coverage run:
### Integration tests (Standalone)
Open a terminal and change to the project's directory:
```
cd /path/to/nostr-ts-relay
```
Set the following environment variables:
```
@ -207,8 +237,6 @@ To see the integration test coverage report open `.coverage/integration/lcov-rep
open .coverage/integration/lcov-report/index.html
```
To see the
## Configuration
You can change the default folder by setting the `NOSTR_CONFIG_DIR` environment variable to a different path.