Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dolu89/nostr-proxy
Nostr proxy: save you WS connections
https://github.com/dolu89/nostr-proxy
nostr
Last synced: 3 months ago
JSON representation
Nostr proxy: save you WS connections
- Host: GitHub
- URL: https://github.com/dolu89/nostr-proxy
- Owner: Dolu89
- License: mit
- Created: 2023-02-10T20:36:32.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-23T10:48:08.000Z (over 1 year ago)
- Last Synced: 2024-02-17T05:34:34.661Z (9 months ago)
- Topics: nostr
- Language: TypeScript
- Homepage: https://nproxy.cc
- Size: 974 KB
- Stars: 59
- Watchers: 3
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nostr - nostr-proxy - proxy?style=social) - Push and get events to your Proxy, get results from multiple Nostr relays. (Tools / Client reviews and/or comparisons)
README
# Nostr Proxy
Push and get events to your Proxy, get results from multiple Nostr relays
## Installation
In the project directory, run:
```sh
pnpm install
```
Edit your env variables. You can use a `.env` file by copying the file `.env.example` in the root directory, or you can set your variables into your hosting provider UI.\
For `APP_KEY`, you can use the following command to generate one `node ace generate:key`
```
PORT=3333
HOST=0.0.0.0
NODE_ENV=development
APP_KEY=unique-key
DRIVE_DISK=local
SESSION_DRIVER=cookie
CACHE_VIEWS=false
PROXY_URL=wss://your-proxy.com
RELAYS=wss://relay1.com,wss://relay2.com,wss://relay.com
```
## Launch
### Development
`npm run dev` to start the app in dev mode.\
Open [http://localhost:3333](http://localhost:3333) to view it in the browser.\
Use `ws://localhost:3333` into your Nostr client.
### Production
```
npm run build
cd build
pnpm install --prod
node server.js
```
### Running tests
TODO
## Known issues
- None?
## Learn More
- [Nostr](https://github.com/nostr-protocol/nostr)
- [Awesome Nostr](https://github.com/aljazceru/awesome-nostr)
## License
This project is MIT licensed.