@@ -58,12 +58,21 @@ NIPs with a relay-specific implementation are listed here.
5858
5959## Quick Start (Docker Compose) (Best)
6060
61- Start with:
61+ Install Docker following the [ official guide] ( https://docs.docker.com/engine/install/ ) .
62+ You may have to uninstall Docker if you installed it using a different guide.
63+
64+ Clone repository and enter directory:
65+ ```
66+ git clone [email protected] :Cameri/nostr-ts-relay.git 67+ cd nostr-ts-relay
68+ ```
69+
70+ Start with:
6271 ```
6372 npm run docker:compose:start &
6473 ```
6574
66- Stop the server with:
75+ Stop the server with:
6776 ```
6877 npm run docker:compose:stop
6978 ```
@@ -88,6 +97,12 @@ Create `nostr_ts_relay` database:
8897 postgres=# quit
8998 ```
9099
100+ Clone repository and enter directory:
101+ ```
102+ git clone [email protected] :Cameri/nostr-ts-relay.git 103+ cd nostr-ts-relay
104+ ```
105+
91106Install dependencies:
92107
93108 ```
@@ -128,6 +143,11 @@ To clean up the build, coverage and test reports run:
128143
129144### Unit tests
130145
146+ Open a terminal and change to the project's directory:
147+ ```
148+ cd /path/to/nostr-ts-relay
149+ ```
150+
131151Run unit tests with:
132152
133153 ```
@@ -158,6 +178,11 @@ To see the unit tests coverage report open `.coverage/unit/lcov-report/index.htm
158178
159179### Integration tests (Docker Compose)
160180
181+ Open a terminal and change to the project's directory:
182+ ```
183+ cd /path/to/nostr-ts-relay
184+ ```
185+
161186Run integration tests with:
162187
163188 ```
@@ -172,6 +197,11 @@ And to get integration test coverage run:
172197
173198### Integration tests (Standalone)
174199
200+ Open a terminal and change to the project's directory:
201+ ```
202+ cd /path/to/nostr-ts-relay
203+ ```
204+
175205Set the following environment variables:
176206
177207 ```
@@ -207,8 +237,6 @@ To see the integration test coverage report open `.coverage/integration/lcov-rep
207237 open .coverage/integration/lcov-report/index.html
208238 ```
209239
210- To see the
211-
212240## Configuration
213241
214242You can change the default folder by setting the ` NOSTR_CONFIG_DIR ` environment variable to a different path.
0 commit comments