retorrent logo


Twitter Follow License

What is retorrent?

retorrent is a re-implementation of BitTorrent protocol in Golang.

Using retorrent

To use retorrent, download the latest release for your platform and fire the following commands.

  1. Download the latest retorrent/releases for your platform.
  2. Extract the binary from the just downloaded compressed artifact
  3. Execute the binary as shown in the following steps

$ ./retorrent

        ██████  ███████ ████████  ██████  ██████  ██████  ███████ ███    ██ ████████ 
        ██   ██ ██         ██    ██    ██ ██   ██ ██   ██ ██      ████   ██    ██    
        ██████  █████      ██    ██    ██ ██████  ██████  █████   ██ ██  ██    ██    
        ██   ██ ██         ██    ██    ██ ██   ██ ██   ██ ██      ██  ██ ██    ██    
        ██   ██ ███████    ██     ██████  ██   ██ ██   ██ ███████ ██   ████    ██    

Developing retorrent

If you are a developer and want to modify retorrent, you will have first to set up a dev environment, and it has the following pre-requisites

Once you have set up all the pre-requisites, following the steps to start your development.

Once you start the server, it will download all the necessary packages and execute the root command.

Linting

Maintaining coding standards is extremely critical, and retorrent follows the standard Gofmt to reformat the code. It is customary to fire the following command before you commit.

make lint

Contribution Guidelines

The Code Contribution Guidelines are published at CONTRIBUTING.md; please read them before you start making any changes. This would allow us to have a consistent standard of coding practices and developer experience.

The RelogX Umbrella

relog logo

Relog is an initiative that aims to transform engineering education and provide high-quality engineering courses, projects, and resources to the community. To better understand all the common systems, we aim to build our own replicated utilities, for example, a load balancer, static file server, API rate limiter, etc. All the projects fall under Apache License, Version 2.0, and you can find their source code at github.com/relogX.

License

retorrent is under Apache License, Version 2.0

GitHub

View Github