Setup, install, and onboard new developers to Reactive Data Client monorepo - nvm, yarn, build, test, getting started guide
Get a new developer up and running with the Reactive Data Client monorepo.
Install prerequisites
nvm installcorepack enableyarn --version (should be 4.x)Install dependencies
yarn install from repo rootBuild the project
yarn build to build all packagesRun tests
yarn test to verify everything worksProject familiarization
packages/endpoint – Base endpoints and declarative schemaspackages/rest – REST modeling (resource(), RestEndpoint)packages/core – Framework-agnostic normalized storepackages/react – React hooks (useSuspense, useLive, useQuery)packages/vue – Vue 3 composablespackages/normalizr – Schema/Entity/normalizationexamples/Optional: Start website locally
cd website && yarn startyarn install completed without errorsyarn build succeedsyarn test passespackages/ structureCONTRIBUTING.mdexamples/todo-app or examples/github-app)| Command | Description |
|---|---|
yarn build | Build all packages |
yarn test | Run all tests |
yarn lint | Run ESLint |
yarn format | Auto-fix lint issues |
yarn changeset | Create a changeset for your PR |