CONTRIBUTING.md

Contributing to Trigger.dev

Thank you for taking the time to contribute to Trigger.dev. Your involvement is not just welcomed, but we encourage it! 🚀

Please take some time to read this guide to understand contributing best practices for Trigger.dev.

Thank you for helping us make Trigger.dev even better! 🤩

Developing

The development branch is main. This is the branch that all pull requests should be made against. The changes on the main branch are tagged into a release monthly.

Prerequisites

• Node.js version >=16.x
• pnpm package manager version 7
• Docker

Setup

1. Clone the repo into a public GitHub repository or fork the repo. If you plan to distribute the code, keep the source code public to comply with the Apache Licence 2.0.

   git clone https://github.com/triggerdotdev/trigger.dev.git
   

   If you are on windows, run the following command on gitbash with admin privileges: git clone -c core.symlinks=true https://triggerdotdev/trigger.dev.git

2. Navigate to the project folder

   cd trigger.dev
   

3. Install the required packages using pnpm.

   pnpm i
   

4. Create your .env files

   cp .env.example .env && cp packages/database/.env.example packages/database/.env
   

5. Open the root .env file and fill in the required values Magic Link:

   Both of these secrets should be random strings, which you can easily generate (and copy into your pasteboard) with the following command:

   openssl rand -hex 16 | pbcopy

   Then set them here:

   SESSION_SECRET=<string>
   MAGIC_LINK_SECRET=<string>
   

6. Start Docker. This starts the required services like Postgres.

   pnpm run docker
   

7. Migrate the database

   pnpm run db:migrate
   

8. Run the seed script

   pnpm run db:seed
   

9. Run the app. See the section below.

Running

1. You can run the app with:

   pnpm run dev --filter webapp
   

   It should run on port 3030: http://localhost:3030

2. Once the app is running click the magic link button and enter your email.

3. Check your terminal, the magic link email should have printed out.

4. Paste the magic link shown in your terminal into your browser to login.

Making a pull request

If you get errors, be sure to fix them before committing.

• Be sure to check the "Allow edits from maintainers" option while creating you PR.
• If your PR refers to or fixes an issue, be sure to add refs #XXX or fixes #XXX to the PR description. Replacing XXX with the respective issue number. See more about Linking a pull request to an issue .
• Be sure to fill the PR Template accordingly.