James Ritchie
6270abaab8
* Make the tooltip text color grey so it’s readable again the primary color * Setup and styling for the Guides section * Better Guides icon * Improved the prerequisites * WIP Nextjs guide and new folder structures * Copy updates * Useful next steps is now a snippet * Better icons for the next steps section * Renamed the “prerequisites” snippet * Node.js guide * Added a “Creating a project” guide * New snippet for prerequisites * New Remix guide * Added Remix to the side bar * Tweaked icons for creating a project page * Added the hello world step to the onboarding steps * Better “useful next steps” snippet card links * Moved prerequisites * Fixing links to images * Moved v2 migration page to guides * Removed dead link * Attempt fix for redirect * Fixed redirects * Getting started section includes link to roadmap * Removed icon from side menu * Deleted all v2 pages (excluding updating mint.json) * Removed v2 pages, redirects and versions from mint.json * Deleted v2 snippets * Deleted un-used pages * Set of more useful coming soon snippets * All snippets use the updated format * updated folder “v3/“ with “/pages” * Moved all main docs files to the route and updated the redirect * Fixed URLs in the mdx pages to the new route path * URL goes to the proper pricing page * Better delayed runs image * Attempt fix for self hosting page not redirecting
32 lines
827 B
Plaintext
32 lines
827 B
Plaintext
<Step title="Run the CLI `init` command">
|
|
|
|
The easiest way to get started it to use the CLI. It will add Trigger.dev to your existing project, create a `/trigger` folder and give you an example task.
|
|
|
|
Run this command in the root of your project to get started:
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npx trigger.dev@beta init
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm dlx trigger.dev@beta init
|
|
```
|
|
|
|
```bash yarn
|
|
yarn dlx trigger.dev@beta init
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
It will do a few things:
|
|
|
|
1. Log you into the CLI if you're not already logged in.
|
|
2. Create a `trigger.config.ts` file in the root of your project.
|
|
3. Ask where you'd like to create the `/trigger` directory.
|
|
4. Create the `/trigger` directory with an example task, `/trigger/example.[ts/js]`.
|
|
|
|
Install the "Hello World" example task when prompted. We'll use this task to test the setup.
|
|
|
|
</Step> |