Skip to content

layerx-labs/webnetwork-events

Repository files navigation

WebApp Logo

This project is a API service to check and process events mined at chain to keep Web Network updated.
Learn more about.

Quick StartedDocumentationContributingCommunity


We are delighted to announce the release of Bepro Network's v2 protocol and we would invite to try it.


This project is an API to listen events from blockchain and manage the database for keep web-network updated.

It is able to run as http server and as a cronjob, and it's essential for running web-network correctly.

1. Prerequisites

2. Quick Started

Install project dependencies:

$ npm install

Create a new .env file based on the default example.

$ cp .env.example .env

Remember to fill in the .env with your enviroment values

Run as http server:

$ npm run dev

Run as cronjob module:

$ npm run build
$ npm run start:cron

3. Documentation

3.1 Architecture

Folder Description
db models and configuration
tools scripting tools
actions event-reader actions to be consumed by cma
utils helpers for developers

3.2 Scripts

Script Description
update-models pull models from db
dev run http server dev mode
start:server run http server
start:cron run cronjob

4. Contributing

See CONTRIBUTING.md for our guide to contributing to web-network.

5. Join the community