Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CodyTseng committed Mar 16, 2024
1 parent 822e816 commit ccf183c
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 4 deletions.
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Powered by [nostr-relay](https://github.com/CodyTseng/nostr-relay) & [NestJS](https://nestjs.com/).

A Nostr relay with a clear architecture and high test coverage
A high-performance nostr relay, using PostgreSQL.

If you'd like to help me test the reliability of this relay implementation, you can add wss://nostr-relay.app to your relay list (it's free) 💜⚡️

Expand Down Expand Up @@ -70,8 +70,7 @@ Build image
Create `.env` file based on [example.env](./example.env) file

```.env
DOMAIN=localhost
DATABASE_URL=postgresql://username:xxxxxxxxxx@host:port/database
DATABASE_URL=postgresql://username:password@host:port/database
```

Run container
Expand All @@ -80,6 +79,36 @@ Run container
./scripts/run.sh
```

### Local Development

First of all, you need to have a PostgreSQL database running.

Clone the repository and install dependencies

```bash
git clone https://github.com/CodyTseng/nostr-relay-nestjs.git
cd nostr-relay-nestjs
npm install
```

Create `.env` file based on [example.env](./example.env) file

```.env
DATABASE_URL=postgresql://username:password@host:port/database
```

Execute migration scripts

```bash
npm run migration:run
```

Start the server

```bash
npm run start
```

## Metrics

You can view some simple relay metrics on `/metrics` endpoint.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "nostr-relay-nestjs",
"version": "2.0.0",
"description": "A Nostr relay with a clear architecture and high test coverage",
"description": "A high-performance nostr relay, using PostgreSQL",
"author": "codytseng",
"private": true,
"license": "MIT",
Expand Down

0 comments on commit ccf183c

Please sign in to comment.