Lightyear Docs

Quick start

How to get going with Lightyear

Getting Started with Lightyear

Welcome to Lightyear! This quick start guide will walk you through creating your first integration project. By the end of this tutorial, you'll have built a working integration that syncs tasks with a sample todo application.

What You'll Learn

  • How to create a new Lightyear project
  • Understanding the project structure
  • Building a simple integration with a todo app
  • Testing your integration in development
  • Deploying your integration to production

Prerequisites

Before you begin, make sure you have:

  • Node.js v18 or later installed
  • Git installed
  • Basic familiarity with TypeScript

Follow the steps in this guide to get up and running with Lightyear in minutes. Let's get started!

Tutorial Steps

  1. Create a project - Set up your development environment
  2. Understand the project - Learn about the project structure
  3. Tour the dashboard - Explore the Lightyear dashboard
  4. Create a TodoApp account - Create a TodoApp account
  5. Create and authorize a managed user - Create and authorize a managed user
  6. View synced data - View synced data
  7. Make a change to the task management collection - Make a change to the task management collection
  8. Deploy to production - Deploy to production
  9. Next steps - Next steps

On this page