Skip to content

metakgp/hermes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Contributors Forks Stargazers Issues AGPL-3.0 License Wiki


image

HERMES

High speed Encrypted and Real-time Messaging and Efficient Sharing
A modern P2P replacement for DC++ on KGP networks
Request Feature / Report Bug

Table of Contents

About The Project

HERMES is a work-in-progress project aimed at modernizing and eventually replacing the legacy DC++ file sharing system used on KGP network. It is being developed using Tauri and Svelte, with a decentralized peer-to-peer architecture powered by iroh

Note

Currently in active development. Get involved at our Slack.

Architecture

The project consists of two main components:

  1. Host (host/ folder):

    • Central server component hosted on campus Raspberry Pi
    • Handles user registration, nickname management, and moderation
  2. Peer (peer/ folder):

    • Cross-platform desktop client application
    • Built with Tauri (Rust backend) + Svelte (TypeScript frontend)
    • Handles direct P2P file transfers and messaging
    • Uses iroh for networking and NAT traversal

(back to top)

Development Setup

To set up a local development environment for HERMES, follow the steps below.

  1. Clone the repository

    git clone https://github.com/metakgp/hermes.git
  2. Navigate to the project directory

    cd hermes
  3. Follow the development setup instructions below for your component of interest.

Host

TODO: Host development setup instructions will be added as the server component is developed.

Peer

Prerequisites

Development

  1. Navigate to the peer directory

    cd peer
  2. Install dependencies

    pnpm install
  3. Start the development server

    pnpm tauri dev

This will start the Tauri development environment with hot-reload enabled for both the Rust backend and Svelte frontend.

(back to top)

Usage

HERMES is currently in active development. Once released, it will provide:

  • File Sharing: Direct P2P file transfers between campus users
  • Real-time Chat: Instant messaging with connected peers

More usage examples and screenshots will be added as the project progresses.

(back to top)

Contact

📫 Metakgp - Metakgp's slack invite Metakgp's email metakgp's Facebook metakgp's LinkedIn metakgp's Twitter metakgp's Instagram

Maintainer(s)

The currently active maintainer(s) of this project.

(back to top)

Additional documentation

(back to top)