Web3 Examples

IN PROGRESS

This repository contains the example scripts for the Web3.js documentation, severall starter projects and examples of Web3.js modules.

Web3 Documentation

Documentation, API reference, and templates for the web3js library.

Getting Started

Install docsify and serve the docs locally.

npm install
npm run compile
npm run start

Prerequisites

NodeJS, Python, git (for git bash), and npm are required to run and test.

Running the tests

start Ganache at first.

npm run build
npm run test

Break down into end to end tests

Each test checks if the example is working and up-to-date.

Contributing

In CONTRIBUTING.md you can find the templates for the API docs reference, as well as the structure for the example packages.

Authors

• Oscar "Cehhiro" Fonseca - contributor - OFRBG
• Samuel Furter - contributor - nivida

See also the list of contributors who participated in this project.