Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 1.57 KB
Raw

Developing Cadence's Web UI

This doc is intended for contributors to cadence-web

Note: All contributors will be asked to sign Uber Contributor License Agreement during the PR process.

Development Environment

Node.js. Check package.json for the current version required. We do not recomment nvm since it can provide confusion with npm version.

For development we recommend using VSCode with Remote Containers plugin. We provide a default configuration for remote container using docker-compose.

You also need to run cadence-server locally or have access to a cadence environment to talk to.

Working with the source code

Follow this great guide on how to work with a GitHub fork and submit a pull request.

Building

The standard node.js workflow is used here. Use Node version 10. Version 12 is unable to install the farmhash package.

npm i
npm run dev   # webpack hot reload environment
npm start     # for production

Testing

Start up the webserver for testing via:

npm run test-server

The open localhost:8090 in the browser of your choice, or use npm test to run it with mocha-chrome from the command line. This runs the tests via Chrome in headless mode and shows the results in your terminal.