Skip to content
@PeerBrain

Peer Brain

A decentralized peer to peer social network.

Peer Brain - A Decentralized P2P Social Network App

This open-source project implements a peer-to-peer social network app where users are represented as brain cells. It is completely decentralized and there is no central authority or recommendation algorithms, nor is there any censorship. Messages are propagated between users in a meritocratic way, and users have control over the strength of the signals they receive. This allows for more free and open communication between users.

If you want to contribute, you can fork this repository and issue pull requests! Feel free to use ChatGPT or OpenAI to help you with the coding.

Table of Contents

  1. Updates
  2. How does the open-source workflow work?
  3. Encryption Mechanism
  4. Installation/Instructions
  5. Resources

Updates

2023/04/14

  • Move to Peerbrain organization on Github
  • Codebase split into its components
  • User delete functionality added
  • Various bug fixes

2023/03/15

  • Code clean-up
  • User account creation now requires email verification before allowing you to login
  • Password reset functionality has been added

How does the open-source workflow work?

The open-source workflow is a process by which users can contribute to a project. It is typically done through a system like GitHub, where users can fork, or copy, a repository, make changes to it, and then submit a pull request. The project maintainers then review the changes and either accept or reject them. If accepted, the changes are merged into the main repository. This process allows for collaboration between users and for projects to be updated and improved quickly.

Encryption Mechanism

  1. Load symmetric key.
  2. Encrypt the user entered message using the symmetric key.
  3. Fetch the public key from the server.
  4. Encrypt the symmetric key using the public key.
  5. Decrypt the encrypted symmetric key using the private key.
  6. Decrypt the encrypted message using decrypted symmetric key.
    This is encryption cycle for each message we write or read.

Installation/Instructions

  1. Clone the PeerBrain Repo to your local machine
  2. Now navigate to client directory
  3. Install all the packages from the requirements.txt file using command:
pip install -r requirements.txt
  1. After successful installation, start the client service. Don't change anything in the code :) When everything runs fine as expected, you will see the menu as below:
  2. First step is to register yourself with the application.Select option 2 to register. PeerBrain1
  3. After successful registration, try to login into the application with details you have used during registration process. PeerBrain2
  4. After successful login, you will be able to see the Main menu as below: PeerBrain3
  5. Make sure you have generated the keys prior exploring the application. To generate keys Navigate to Account details section, select generate the keys(2nd option).

Congratulations 🎉 and Thanks for making it till here. Please free feel to explore the application menu ☺️. Happy journey!

Resources

Here are some resources about this project:

  • Finxter Youtube project start video -The video that started it all.

  • Git basics -This article talks about how to use Git versioning, which comes in handy when working on open source projects.

  • Symmetric Key Exchange Server -This server takes care of storing the symmetric keys and sending back the encrypted versions of these when a user wants to read a friends messages. It is a part of this project but it doesn't share any resources with it. The two are separated to ensure the security of the symmetric keys.


linting: pylint

Pinned Loading

  1. cli-client cli-client Public

    Peer Brain CLI Client

    Python 2 1

  2. gui-client gui-client Public

    Peer Brain GUI Client

    HTML 1 1

  3. web-client web-client Public

    Peer Brain Web Client

    JavaScript 2

  4. server server Public

    Peer Brain Server

    Python 2 1

Repositories

Showing 9 of 9 repositories
  • server Public

    Peer Brain Server

    PeerBrain/server’s past year of commit activity
    Python 2 AGPL-3.0 1 0 0 Updated Jun 5, 2023
  • web-client Public

    Peer Brain Web Client

    PeerBrain/web-client’s past year of commit activity
    JavaScript 2 0 0 0 Updated May 30, 2023
  • mfa Public

    Multi Factor Auth for PeerBrain

    PeerBrain/mfa’s past year of commit activity
    JavaScript 0 0 0 0 Updated Apr 30, 2023
  • docs Public

    Documentation for the PeerBrain project

    PeerBrain/docs’s past year of commit activity
    JavaScript 0 0 0 0 Updated Apr 29, 2023
  • gui-client Public

    Peer Brain GUI Client

    PeerBrain/gui-client’s past year of commit activity
    HTML 1 AGPL-3.0 1 0 0 Updated Apr 25, 2023
  • .github Public

    GitHub config files

    PeerBrain/.github’s past year of commit activity
    0 0 0 0 Updated Apr 15, 2023
  • cli-client Public

    Peer Brain CLI Client

    PeerBrain/cli-client’s past year of commit activity
    Python 2 AGPL-3.0 1 1 0 Updated Apr 14, 2023
  • static Public
    PeerBrain/static’s past year of commit activity
    CSS 0 0 0 0 Updated Apr 14, 2023
  • symmetric-key-exchange Public

    Peer Brain Symmetric Key Exchange

    PeerBrain/symmetric-key-exchange’s past year of commit activity
    Python 1 AGPL-3.0 0 0 0 Updated Apr 14, 2023

Top languages

Loading…

Most used topics

Loading…