@cbnsndwch/zero-sources

Getting Started with Zero Sources

Learn how to set up and start using Zero Sources

Welcome! This guide will help you get up and running with Zero Sources, from installation to building your first real-time change source.

What You'll Learn

In this section, you'll learn how to:

  • Install Zero Sources and its dependencies
  • Set up your development environment
  • Create your first change source
  • Understand core concepts and architecture
  • Troubleshoot common issues

Prerequisites

Before you begin, ensure you have:

  • Node.js: Version 20 or higher
  • pnpm: Version 8 or higher
  • MongoDB: Version 6.0 or higher with replica set enabled
  • Docker (optional): For containerized deployment
  • TypeScript: Basic knowledge recommended

Learning Path

We recommend following this learning path:

  1. Installation: Set up your development environment
  2. Quick Start: Build a simple change source
  3. Concepts: Understand the underlying architecture
  4. Troubleshooting: Learn how to debug issues

How was this page?