Contributing Guide

Development Setup

Node.js is needed for the development of eruda.

After cloning the repo, run:

bash

# install npm dependencies.
npm install
# copy jasmine lib from node_modules to test folder.
npm run setup

Commonly used NPM scripts

bash

# watch and auto re-build.
npm run dev
# build eruda.js
npm run build
# lint, build and test.
npm run ci

Project Structure

build: webpack configuration, and some other useful scripts.
src: source code, written in es2015.
test: contain pages for testing.