We are hiring. Please check out our about page and submit inquiry from there.

Table of Contents

• Getting Started
• Usage
  • Learn more
  • Build the website
• Project Structure
• Code Style
  • ESLint
  • Prettier
  • VS Code

Getting Started

1. Clone this repository or hit "Use this template" button

git clone git@github.com:bytebase/bytebase.com.git

2. Install dependencies

pnpm install

Usage

pnpm run dev

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

Code Style

ESLint

ESLint helps find and fix code style issues and force developers to follow same rules. Current configuration is based on eslint:recommended, next/core-web-vitals and @typescript-eslint/recommended rules sets.

Additional commands:

pnpm run lint

Run it to check the current status of eslint issues across project.

pnpm run lint:fix

Run it to fix all possible issues.

Prettier

Prettier helps to format code based on defined rules. Difference between Prettier and ESLint.

Additional commands:

pnpm run format

Run it to format all files across the project.

VS Code

Following extensions required to simplify the process of keeping the same code style across the project:

• ESLint
• Prettier

After installation, VS Code will be use settings from the .vscode/settings.json file and will be fixing and formatting your code automatically on paste and save actions.