LogoLogo
HomeDocsGitHubDiscord
master
master
  • Introduction
  • Getting started
    • Installation
    • Upgrading
    • Usage
    • DevTools
  • API
    • Interfaces
    • Configuration options
    • State properties
    • Helper components
  • Guide
    • Async components
    • Separating view and logic
    • Async actions
    • Optimistic updates
    • Server-side rendering
  • Contributing
    • Introduction
    • Setting up
    • Development
    • Testing
    • Releasing
Powered by GitBook
On this page
  • Prerequisites
  • Git
  • Node.js
  • Yarn
  • Project setup
  • Editor setup

Was this helpful?

  1. Contributing

Setting up

PreviousIntroductionNextDevelopment

Last updated 5 years ago

Was this helpful?

Prerequisites

In order to develop React Async on your local machine, you'll need git, node and yarn.

Git

To clone the repository, commit your changes and push them upstream, you'll need to have git .

Node.js

As a JavaScript project, we rely heavily on Node.js. It's recommended to use a version manager such as for Mac / Linux or for Windows to install the latest Node.js with.

Yarn

This repo relies on Yarn workspaces, so you should and use yarn@1.3.2 or higher as the package manager for this project.

Project setup

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.git
cd react-async
yarn install
yarn bootstrap
yarn 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 total
Tests:       136 passed, 136 total

Note that all work is done against the next branch, we only merge to master when doing a release.

Editor setup

We recommend using 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 font.

installed
fnm
nvm-windows
install
Visual Studio Code
Prettier
ESLint
DeepScan
Oceanic Plus
Overpass Mono