g2hhh2ee/yorkie-team.github.io

Yorkie Homepage and Documentation

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

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

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.