Skip to content

Latest commit

 

History

History
111 lines (74 loc) · 3.86 KB

README.md

File metadata and controls

111 lines (74 loc) · 3.86 KB
Raw

🌟 ZKsync Developer Documentation

License License: Apache 2.0 Contributor Covenant Contributions Welcome X (formerly Twitter) Follow

Welcome to the ZKsync Docs repository! This is your go-to hub for all things ZKsync. Dive into our comprehensive documentation whether you're just starting out or looking for advanced guides.

🚀 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

📚 Documentation Overview

Unlock the full potential of ZKsync with our comprehensive resources:

  • 🛠️ Build: Learn how to develop and deploy your smart contracts and applications on ZKsync Era. Our step-by-step guides and tutorials will help you get started quickly and efficiently.

  • 🔗 ZK Stack: Dive into the Zero-Knowledge (ZK) Stack to discover how to configure and build a ZK chain tailored for your application. Explore the architecture, components, and best practices.

  • 🌐 ZKsync Node: Set up and run your own ZKsync full node. Gain a deeper understanding of node operations, observability, and maintenance to ensure optimal performance and reliability.

  • 🌍 Ecosystem: Explore the vibrant ZKsync ecosystem. Discover a wide array of projects and tooling built for ZKsync developers and users, from wallets and explorers to integrations and developer tools. Stay updated with the latest innovations and community contributions.

🛠️ Built With

🖥️ Local Development

Run the project locally:

bun run dev

Lint & Formatting ✨

This project provides lint commands to check the project.

Run CI Checks ✔️

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 linting on the project:

bun run lint:prettier
bun run lint:eslint

🤝 Contributions

We welcome contributions from the community! Check out the following resources to get started:

Check out Community Code

If you want to contribute tutorials to our Docs, check out the Community Code repo!

Join us in making ZKsync Docs better for everyone! 🌐✨

Issues

'failed to fetch git tree'

If your bun install fails with 'failed to fetch git tree', this is probably due to the github rate limiting the API for unauthorized accesses. You either have to wait, change ip address or pass the github authorization token.