CONTRIBUTING.md

Developing Temporal's Web UI

This doc is intended for contributors to temporal-web.

Note: All contributors also need to fill out the Temporal Contributor License Agreement before we can merge in any of your changes.

Development Environment

You will need Node.js. We recommend Node.js 14. You may wish to use nvm to manage your versions.

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

Here is a 5 minute local dev setup guide for Temporal Web you can follow:

Working with the source code

If you are new to GitHub and open source, you can follow this guide on how to work with a GitHub fork and submit a pull request.

Building

The standard node.js workflow is used here. We recommend using at least Node v14.

# before initial setup
make # to set up proto
npm i # to install npm dependencies

# choose either dev or start
npm run dev   # webpack hot reload environment
npm run 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.