Matt Aitken
1a4952720f
* Early work defining CLI framework support * WIP moving CLI init logic to the Framework class * Installing files should now work for Nextjs * Some fixes * WIP creating unit tests for Next.js project detection * Delete old jest config * Latest lockfile * Detect use of src directory test * Tests for detection pages/app directory * Correct detection of Next.js project * Renamed test file * Create install files from template files with replacements. With tests * Added multiple uses of the same replacement * Created a test for the install step (it fails right now with JS) * Removed unused import * Another test that should pass but currently fails… * Path alias fixed and now has tests * New pathAlias function used * Nextjs page install tests * Fixed app directory install (with tests) * Removed e2e CLI test, switched to unit testing strategy instead * Latest lockfile * The install files are now actual files that are copied and transformed * Got the template files working correctly after building * Next steps are now framework specific * createFileFromTemplate now works with a path again. Uses mock if specified. * Renamed apiRoute.js to pagesApiRoute.js * Simplified pages file generation * Next.js app API route template * Next.js App routing support, with common files logic shared * Dev command now uses framework default values if they exist and aren’t overridden * Unused import * pathAlias now works for all frameworks * Added a test to detect Next from the next.config.js * WIP on Remix framework support * Tests for Remix install * Replaced references to Next.js * Use a green ✔️ instead of ✅ in the CLI * Support for multiple hostnames * Tunneling can now use the hostname and port * Work on multiple ports * Improved the error messages. Added some extra pots to Next.js * Update the Remix templates to have .server in the imports * Remix updated to use server-runtime instead of node. Node v18+ * Frameworks can specify the watch paths and ignore paths * Define the watch variables above, so we can easily log them for debugging * Don’t wait for outdated package checking when running the dev command * Improved the Remix manual setup guide * Rewriting docs for quickstart * Updated the Next.js quickstart * Remix quick start * Added a changeset * Improved the Next.js manual setup
81 lines
1.6 KiB
Plaintext
81 lines
1.6 KiB
Plaintext
<Step title="Create a Trigger.dev account">
|
|
|
|
You can either:
|
|
|
|
- Use the [Trigger.dev Cloud](https://cloud.trigger.dev).
|
|
- Or [self-host](/documentation/guides/self-hosting) the service.
|
|
|
|
</Step>
|
|
|
|
<Step title="Create your first project">
|
|
|
|
Once you've created an account, follow the steps in the app to:
|
|
|
|
1. Complete your account details.
|
|
2. Create your first Organization and Project.
|
|
|
|
</Step>
|
|
|
|
<Step title="Getting an API key">
|
|
|
|
1. Go to the "Environments & API Keys" page in your project.
|
|
|
|
|
|
2. Copy the `DEV` **SERVER** API key.
|
|
|
|
|
|
</Step>
|
|
|
|
<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, setup a route and give you an example file.
|
|
|
|
In a terminal window run:
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npx @trigger.dev/cli@latest init
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm dlx @trigger.dev/cli@latest init
|
|
```
|
|
|
|
```bash yarn
|
|
yarn dlx @trigger.dev/cli@latest init
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
It will ask you a couple of questions
|
|
|
|
1. Are you using the [Trigger.dev Cloud](https://cloud.trigger.dev) or [self-hosting](/documentation/guides/self-hosting)?
|
|
2. Enter your development API key. Enter the key you copied earlier.
|
|
|
|
</Step>
|
|
|
|
<Step title="Run your site">
|
|
|
|
Make sure your site is running locally, we will connect to it to register your Jobs.
|
|
|
|
<Warning>You must leave this running for the rest of the steps.</Warning>
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npm run dev
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm run dev
|
|
```
|
|
|
|
```bash yarn
|
|
yarn run dev
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
</Step>
|