Sugidama

Overview

This is the repository for my personal development project, 'Sugidama'.

• Project documentation on DeepWiki

Development

Installing packages

npm install

Execution of development tasks

Execute the following command.

npm run dev

The following URL will take you to the screen.

http://localhost:5173/

• Press Ctrl + C to stop

Syntax Check

Check

npm run lint

Check and Format

npm run lint-fix

Formatter

Check

npm run format

Check and Format

npm run format-fix

Type Check

npm run typecheck

Storybook

npm run storybook

Test(Vitest)

npm run test

Upgrading packages

Check

npm run upgrade-check

Upgrade

npm run upgrade
npm install

API Documentation

Creating API Types

API type definitions are generated using quicktype.

1. Copy the JSON response from the Kuroco CMS API
2. Paste it into quicktype and select TypeScript as the target language
3. Save the generated types to app/types/