In order to develop React Async on your local machine, you'll need
To clone the repository, commit your changes and push them upstream, you'll need to have
This repo relies on Yarn workspaces, so you should install and use
email@example.com or higher as the package manager for this project.
To start working on React Async, clone the repository and bootstrap the project by running the following commands one-by-one:
git clone https://github.com/async-library/react-async.gitcd react-asyncyarn installyarn bootstrapyarn test
This should install all dependencies, build and link the react-async and react-async-devtools packages to the examples, and finally run the unit tests. In the end it should succeed with a message (numbers may change):
Test Suites: 6 passed, 6 totalTests: 136 passed, 136 total
Note that all work is done against the
nextbranch, we only merge to
masterwhen doing a release.
We recommend using Visual Studio Code with the following extensions:
Make sure to enable
editor.formatOnSave, so Prettier will automatically apply the right code style. For the full immersive experience you can also install and use the Overpass Mono font.