Community Code

Welcome to the zkSync Community Code repository. This project serves as the community hub for zkSync, providing comprehensive documentation for developers written by developers. Whether you're a beginner looking to get started with zkSync or an experienced developer seeking advanced guides, you'll find the resources you need here.

🚀 Quick Start

1. Install Bun: Follow the installation instructions.

2. Install Dependencies:

   bun install

3. Run Locally: Start the development server at http://localhost:3000.

   bun run dev

🛠️ Built With

• Vue
• Nuxt
• Nuxt Content
• Nuxt UI & Nuxt UI Pro
• Tailwind
• Bun

Local Preview 👀

To locally preview the production build, first run bun run build to build the project, then run the following:

bun run preview

Lint & Formatting ✨

This project provides lint commands to check the project.

Run CI Checks ✔️

This command will run all of the lint commands together.

bun run ci:check

Markdown Linting 📝

Markdown files are found in the /content directory. The following lint commands will run within that directory:

bun run lint:spelling
bun run lint:markdown

Linting 🧹

The following commands are available to run code linting on the project:

bun run lint:prettier
bun run lint:eslint

📜 Conventional Commits

We follow the Conventional Commits specification. Make sure your commit messages adhere to these guidelines.

For documentation changes, we recommend using the "docs:" tag. For example:

git commit -m "docs: fix spelling error"

🤝 Contributions

We welcome contributions from the community! Check out our Contributing guide to learn how to add your own guides to Code Community.

👪 Join the community

If you haven't already, join our community! We have GitHub Discussions for developers to ask questions and share their work. We also have a Discord server for real-time conversations with the team and community.

Be sure to follow us on Twitter to keep up to date with announcements from the zkSync dev team.