1 unstable release

0.1.0 Apr 2, 2024

#1353 in Web programming

Download history 122/week @ 2024-03-27 51/week @ 2024-04-03

173 downloads per month

MIT license

34KB
875 lines

Nostr Relay Project (Work in Progress)

This project is based on the rust-nostr implementation and serves as a Nostr relay.

Prerequisites

Ensure that you have Docker, docker-compose, and necessary script execution permissions on your system. If you intend to build and run without Docker, you also need the sh shell and the project's build dependencies installed.

Getting Started

Here's how you can set up and run the project:

Running Without Docker

  1. Build the project: Use the provided shell script for building the project.

    sh build.sh
    
  2. Navigate to the output directory: The build output directory contains the compiled files and scripts.

    cd output
    
  3. Run the script: Execute the generated script to run the project.

    sh script.sh
    

Running With Docker

  1. Build the Docker image: This uses the docker-compose.yml configuration to create Docker image for the service.

    docker-compose build
    
  2. Start the service: This command starts the Docker service for the Nostr relay.

    docker-compose up
    

Dependencies

~43–58MB
~1M SLoC