Skip to content

doc need: creating a new reference project and deploying it locally #1362

Closed
@ericallam

Description

@ericallam

We're missing a doc in the repo (ideally at references/README.md) that details how to:

  • Create a new reference project by copying the hello-world reference project
  • Get the dev CLI command running against a local instance of Trigger.dev (e.g. the webapp)
  • Get the deploy CLI command running against a local instance of Trigger.dev by setting up and running the webapp alongside the coordinator and docker-provider:
pnpm run dev --filter webapp --filter coordinator --filter docker-provider

Then deploying it like so:

pnpm exec trigger deploy --self-hosted --load-image

This README should also make sure the CONTRIBUTING.md guidelines are enough to get the webapp running locally.

This new README should be sufficient for a new contributor to come in from scratch and create a new reference project and both run it in dev and deploy it.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions