https://github.com/rishiosaur/banur

🏴 Banur - decentralized, realtime communication.
https://github.com/rishiosaur/banur

Last synced: about 1 year ago
JSON representation

🏴 Banur - decentralized, realtime communication.

• Host: GitHub
• URL: https://github.com/rishiosaur/banur
• Owner: rishiosaur
• License: mpl-2.0
• Created: 2020-10-26T02:24:44.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-01-15T19:07:34.000Z (over 5 years ago)
• Last Synced: 2025-04-13T22:12:28.018Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 910 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
![Header](assets/banur-header.svg)

# 🏴 Banur

![lint status](https://github.com/rishiosaur/banur/workflows/lint/badge.svg)

![format status](https://github.com/rishiosaur/banur/workflows/format/badge.svg)

![build status](https://github.com/rishiosaur/banur/workflows/build/badge.svg)

![GitHub](https://img.shields.io/github/license/rishiosaur/banur)

## Getting Started

Before doing anything, make sure you read through the specification documentation to truly understand how the different server pieces fit together.

### Spinning up an instance

You can start up a server by using the Banur CLI (also packaged in this repository): `npx @banur/cli epoch` or `npx @banur/cli petrichor`.

### Local development

After cloning this repository, use `lerna bootstrap` to install all dependencies for all packages. You may need to `cd` into each package and run `yarn` to install any side dependencies.

Both [`epoch`](packages/epoch) and `petrichor` are just Typescript libraries. You can run `npm link` in each of their directories to allow your local distribution (run `yarn build` before) to be locally tested & used.

The [`cli`](packages/cli) package also has support for `npm link`, but it it meant to be used in the terminal.

## Packages

This repository is a monorepo managed by [Lerna](lerna.json), and holds all the core serverware, packages and clients distributed over NPM for Banur.

|          Name           |                                                                            Description                                                                            |

| :---------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------: |

|   [CLI](packages/cli)   |                                     CLI for spinning up & managing Banur instances. Pulls templates from custom repositories.                                     |

| [Epoch](packages/epoch) |                                            Community server library; distributed instances of discrete channels & RTM.                                            |

|        Petrichor        | Coming soon. Library for the core network server; allows distributed instances of Epoch to be linked together into discrete communities in one centralized space. |