Skip to content

Overview and Development Guide

Chris Trevino edited this page May 9, 2017 · 1 revision

This document describes the release process used by the React-DnD project. The project is a monorepo of the various npm packages that compose the React-DnD project. This includes the dnd-core, react-dnd, html5-backend, test-backend, and the documentation for the public website.

The master branch of the project is considered stable, and is configured to be protected from direct edits. Changes to the master branch should be code reviewed and pass CI before being integrated.

The project is configured to use the Yarn package manager. To initialize the project and execute tests:

> yarn install
> yarn test

To start the public website and view the documentation, execute:

> yarn start

Once the webpack bundling is complete, the documentation site will be hosted at http://localhost:8080/webpack-dev-server/.