Step 1 - Create a Project
- Node (opens in a new tab) v16.17, or greater (check with
- Git (opens in a new tab)
Create your project
Use the command line to create a project directory using our template. In this tutorial, we will use the name
lightyear-integrations for the project, but you can choose any name you like for your project.
npx @runlightyear/cli create lightyear-integrations
Change to the newly created project directory and use your preferred package manager to install the project packages.
cd lightyear-integrations npm install
Create your lightyear account using the command line.
To sign up you need to be on our waitlist. We onboard new people every week. Join Waitlist → (opens in a new tab)
npx lightyear signup
This will create a
.env file in your project root with your credentials.
If you already have an account, you can use the command
npx lightyear login
yarn lightyear login and confirm that you want to use an existing
Run the development server
Once you have installed the project dependencies and authenticated with the platform, you can start the development server by running the following command:
npm run dev
Once the development server is running, it will automatically deploy your integrations whenever you make changes to the source code. This allows you to see your changes in real-time and quickly iterate on your integrations as you develop them.