Skip to content

Commit

Permalink
chore: update readme and add funding file
Browse files Browse the repository at this point in the history
  • Loading branch information
jchiarulli committed Sep 17, 2024
1 parent 89154f2 commit 34b5aa4
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 10 deletions.
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These are supported funding model platforms

github: [christianchiarulli, jchiarulli]
patreon: chrisatmachine
58 changes: 48 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,76 @@
# Relay Runner
<div align="center"><p>
<h1>Relay Runner 📡</h1>
<a href="https://github.com/nodetec/relayrunner/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/nodetec/relayrunner?style=for-the-badge&logo=starship&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://github.com/nodetec/relayrunner/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/nodetec/relayrunner?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/nodetec/relayrunner/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/nodetec/relayrunner?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/nodetec/relayrunner">
<img alt="Repo size" src="https://img.shields.io/github/repo-size/nodetec/relayrunner?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
</a>
</div>

Become a relay runner, help decentralize nostr, and take control of your data.
Become a relay runner, help decentralize [Nostr](https://nostr.com/ "Nostr"), and take control of your data.

## For Contributors
[Relay Runner](https://relayrunner.org "Relay Runner") will guide you through the process of setting up various relay implementations from scratch.

This site use [mkdocs material](https://squidfunk.github.io/mkdocs-material/).
You'll learn how to:

To get started, fork and clone the repository then run the following commands:
- Get a server

- Enter the project directory
- Get a domain name

- Set up remote access using SSH

- Configure nginx

- Set up a firewall

- Obtain and set up an SSL/TLS certificate

- Build the relay software

- Install the relay software

- Configure your relay

- Set up a systemd service for your relay

## Contribute

This site use [MKDocs Material](https://squidfunk.github.io/mkdocs-material/ "MKDocs Material").

To get started, fork and clone the repository, then run the following commands:

Enter the project directory:

```bash
cd relayrunner
```

- Create a virtual environment
Create a virtual environment:

```bash
python3 -m venv env
```

- Active the virtual environment
Active the virtual environment:

```bash
source env/bin/activate
```

- Install the `cairo` package (MacOS)
Install the `cairo` package (macOS):

```bash
brew install cairo
```

- Install python dependencies
Install python dependencies:

```bash
pip install -r requirements.txt
Expand Down

0 comments on commit 34b5aa4

Please sign in to comment.