Skip to content

Staco78/VBAN-Messenger

Repository files navigation

VBAN-Messenger

A VBAN-Chat client in Electron and React

⚠️ This project is currently in developpement, it could be bugged or unusable.

Welcome to the beautiful repository of VBAN-Messenger (Also called VBAN-M).

If you want to contribute you can read the VBAN-Messenger Renderer API References, some functions of the API references are not added/finished. The renderer API is the interface between the backend and the renderer (Frontend). You can also contribute by working on the backend or the frontend directly (Figma prototype of the frontend).

How to build VBAN-Messenger for developpment

Prerequisites

Node.js (LTS), git and a configured C++ compiler for Node.js (The doc of node-gyp explain how to do that)

1. Clone repository and install dependencies

Enter the following commands:

git clone https://github.com/Staco78/VBAN-Messenger
cd VBAN-Messenger
npm i

2. Build native modules for electron

Enter the following command:

npm run rebuild

3. Build the projet

Enter the following command:

npm run build

4. Run Electron

Enter the following command:

npm start