OpenParable
Skip to content
← Back to skills

Initialize

Development
initialize

Initialize is an Agent Skill for development published in the reactive/data-client repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Setup, install, and onboard new developers to Reactive Data Client monorepo - nvm, yarn, build, test, getting started guide

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/reactive/data-client/blob/HEAD/.cursor/skills/initialize/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/initialize, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Initialize Development Environment

Overview

Get a new developer up and running with the Reactive Data Client monorepo.

Steps

  1. 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)
  2. Install dependencies

    • Run yarn install from repo root
    • This installs all workspace dependencies
  3. Build the project

    • Run yarn build to build all packages
    • This runs TypeScript compilation and Babel transforms
  4. Run tests

    • Run yarn test to verify everything works
    • Tests use Jest with projects: ReactDOM, Node, ReactNative
  5. 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/
  6. Optional: Start website locally

    • Use workspace task "website: start" or cd website && yarn start
    • Documentation site runs on localhost

Onboarding Checklist

  • Node.js >= 14 and Yarn 4 ready
  • yarn install completed without errors
  • yarn build succeeds
  • yarn test passes
  • Reviewed packages/ structure
  • Read CONTRIBUTING.md
  • Explored an example app (examples/todo-app or examples/github-app)

Helpful Commands

CommandDescription
yarn buildBuild all packages
yarn testRun all tests
yarn lintRun ESLint
yarn formatAuto-fix lint issues
yarn changesetCreate a changeset for your PR

Resources