Initialize Development Environment
Overview
Get a new developer up and running with the Reactive Data Client monorepo.
Steps
- •
Install prerequisites
- •Install Node.js >= 14 via nvm:
nvm install - •Enable Corepack for Yarn 4:
corepack enable - •Verify Yarn:
yarn --version(should be 4.x)
- •Install Node.js >= 14 via nvm:
- •
Install dependencies
- •Run
yarn installfrom repo root - •This installs all workspace dependencies
- •Run
- •
Build the project
- •Run
yarn buildto build all packages - •This runs TypeScript compilation and Babel transforms
- •Run
- •
Run tests
- •Run
yarn testto verify everything works - •Tests use Jest with projects: ReactDOM, Node, ReactNative
- •Run
- •
Project familiarization
- •Review monorepo structure:
- •
packages/endpoint– Base endpoints and declarative schemas - •
packages/rest– REST modeling (resource(),RestEndpoint) - •
packages/core– Framework-agnostic normalized store - •
packages/react– React hooks (useSuspense,useLive,useQuery) - •
packages/vue– Vue 3 composables - •
packages/normalizr– Schema/Entity/normalization
- •
- •Read official docs
- •Explore example apps in
examples/
- •Review monorepo structure:
- •
Optional: Start website locally
- •Use workspace task "website: start" or
cd website && yarn start - •Documentation site runs on localhost
- •Use workspace task "website: start" or
Onboarding Checklist
- • Node.js >= 14 and Yarn 4 ready
- •
yarn installcompleted without errors - •
yarn buildsucceeds - •
yarn testpasses - • Reviewed
packages/structure - • Read
CONTRIBUTING.md - • Explored an example app (
examples/todo-apporexamples/github-app)
Helpful Commands
| 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 |