Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yplog/peerkat-relay
https://github.com/yplog/peerkat-relay
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/yplog/peerkat-relay
- Owner: yplog
- License: mit
- Created: 2024-05-24T13:43:46.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-15T10:38:08.000Z (2 months ago)
- Last Synced: 2024-11-17T05:41:55.765Z (about 1 month ago)
- Language: Go
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Peerkat Relay
Peerkat Relay is a simple and lightweight relay server for [Peerkat](https://github.com/yplog/peerkat). It is designed to be used with Peerkat, a peer-to-peer file sending application.
## Table of Contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Contribution](#contribution)
4. [License](#license)
## Installation
Clone the repository:
```bash
git clone [email protected]:yplog/peerkat-relay.git
```
Install the dependencies:
```bash
go mod tidy
```
To build Peerkat Relay, you can use the following command:
```bash
go build -o peerkat-relay cmd/relay-server/main.go
```
## Usage
To start the relay server, simply run the following command:
```bash
peerkat-relay
```
## Contribution
If you want to contribute to the development of Peerkat, please follow these steps:
1. Fork this repository.
2. Add a new feature or fix a bug.
3. Create a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.