Skip to content

development.md

Latest commit

 

History

History
83 lines (56 loc) · 1.76 KB

development.md

File metadata and controls

83 lines (56 loc) · 1.76 KB

Development Guide

Prerequisites

  • Node.js 18 or newer
  • npm

Setup

npm install
npm run dev

The development app is served from the Vite base path:

http://127.0.0.1:5173/OpenWebSheet/

Build

npm run build

The production build writes static assets to docs/ so GitHub Pages can serve the app.

Testing

npm test

Use watch mode while working on UI behavior:

npm run test:watch

Type Checking

npm run typecheck

Useful Scripts

  • npm run dev: start the local Vite server.
  • npm run build: create the production build in docs/.
  • npm run preview: preview the production build locally.
  • npm run storybook: start Storybook on port 6006.
  • npm run build-storybook: build static Storybook output.
  • npm test: run Vitest once.
  • npm run typecheck: run TypeScript without emitting files.

Storybook

Storybook documents the React UI layer in isolation. Start it with:

npm run storybook

Initial stories live beside the UI components they document:

  • src/shared/ui/*.stories.tsx
  • src/features/ribbon/*.stories.tsx

Use Storybook for component states, visual review, and UI experiments that do not require the spreadsheet canvas.

Contribution Workflow

  1. Create an issue.
  2. Create a branch.
  3. Implement changes.
  4. Run tests and type checking.
  5. Run the production build when changing UI, assets, or configuration.
  6. Open a pull request with a summary and verification notes.

Build Warning

The production build currently reports a direct eval warning from src/lib/core/formula/Evaluator.ts. The warning is known, and the build still succeeds. Changes to the formula engine should address that warning deliberately instead of hiding it in unrelated work.