Skip to content

ONBOARDING.md

Latest commit

 

History

History
84 lines (56 loc) · 1.32 KB

ONBOARDING.md

File metadata and controls

84 lines (56 loc) · 1.32 KB

Onboarding Guide: sindresorhus/ky

Prerequisites Checklist

  • Node.js >=18
  • npm

Clone & Install

# Clone the repository
git clone https://github.com/sindresorhus/ky.git
cd ky

# Install dependencies
npm install

Available Commands

install

npm install

test

npm test

build

npm run build

install-playwright

npx playwright install --with-deps

Development Loop

  1. Start the dev server/watch mode
  2. Make changes to files in source
  3. Changes should hot-reload (if applicable)
  4. Run tests before committing

Running Tests

npm test

Test directories:

  • test

Common Errors & Fixes

Node.js version is lower than 18

Fix: Upgrade Node.js to >=18 as required by engines in package.json.

Playwright browsers not installed for tests

Fix: Run npx playwright install --with-deps before running npm test.

Editor Setup

This project uses: ESM TypeScript with XO linting (npm test runs xo before build and AVA).

Recommended extensions:

  • ESLint / Prettier (if applicable)
  • Language-specific extensions for TypeScript

Getting Help

  • Check existing issues on GitHub
  • Read through the docs in docs/
  • Look at existing code for patterns

Generated by Repo Bootcamp
⚡