Homepage

Homepage is a comprehensive resource for information about Yorkie. It includes detailed documentation and information about Yorkie and its features, capabilities, and usage.

Developing Homepage

Building Homepage

For building homepage, You'll first need Node.js installed(Node.js version 16+ and npm version 7.10+ are required).

# install packages
npm install

# build
npm run build

Running Homepage

In the project directory, you can run:

$ npm run dev

Fetching styles from Yorkie UI

Yorkie UI is a repository that contains the styles of Yorkie. If you want to update the styles of the homepage. You can run the following command. Yorkie UI repository is private, so if you want to run this command, you need to be a member of the Yorkie UI repository.

$ npm run fetch:ui

Fetching fileInfo of examples from Yorkie JS SDK

The examples that are used in the homepage are managed in the Yorkie JS SDK repository. If you want to update examples of the homepage, you can run the following command.

$ npm run fetch:examples

This command will fetch the fileInfo of examples from JS SDK repository and copy them to the /examples directory.

Building example applications

The example applications are built and served directly from the homepage. To build all examples:

$ npm run build:examples

This will:

1. Use yorkie-js-sdk's pnpm build system (from /temp directory)
2. Read API configuration from .env and .env.production environment variables
3. Build static examples using pnpm build:examples
4. Copy built files to public/apps/

Environment Variables:

• NEXT_PUBLIC_API_ADDR: Yorkie API server address (default: https://api.yorkie.dev)
• NEXT_PUBLIC_EXAMPLES_API_KEY: API key for examples (optional)

For full production build including examples:

$ npm run build:full

Note: Make sure to run npm run fetch:examples first to clone the yorkie-js-sdk repository to the /temp directory.

This is a Next.js project bootstrapped with create-next-app.

Details

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Deploying Homepage

When PR is merged into main, it is automatically distributed by GitHub Actions.

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Documentation

• MAINTAINING.md — Release and maintenance procedures
• CLAUDE.md — Agent instructions for AI-assisted development