Skip to content

Commit

Permalink
Update screenshots and framework specific instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
djfarrelly committed Nov 16, 2024
1 parent 1707c26 commit 671e3b5
Show file tree
Hide file tree
Showing 15 changed files with 164 additions and 268 deletions.
18 changes: 9 additions & 9 deletions pages/docs/getting-started/nextjs-quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ bun add inngest

## 2. Run Inngest Dev Server

Next, start the [Inngest Dev Server](https://www.inngest.com/docs/local-development#inngest-dev-server), which is a fast, in-memory version of Inngest where you can quickly send and view events events and function runs:
Next, start the [Inngest Dev Server](/docs/local-development#inngest-dev-server), which is a fast, in-memory version of Inngest where you can quickly send and view events events and function runs:

<CodeGroup>
```shell {{ title: "npm" }}
Expand Down Expand Up @@ -202,9 +202,9 @@ To define the function, use the [`createFunction`](/docs/reference/functions/cre
<summary><strong>Learn more: What is `createFunction` method?</strong></summary>

The `createFunction` method takes three objects as arguments:
- **Configuration**: `id` is required and it is the default name that will be displayed on the Inngest dashboard to refer to your function. You can also specify [additional options](https://www.inngest.com/docs/reference/functions/create#configuration) such as `concurrency`, `rateLimit`, `retries`, or `batchEvents`, and others.
- **Configuration**: `id` is required and it is the default name that will be displayed on the Inngest dashboard to refer to your function. You can also specify [additional options](/docs/reference/functions/create#configuration) such as `concurrency`, `rateLimit`, `retries`, or `batchEvents`, and others.
- **Trigger**: `event` is the name of the event that triggers your function. Alternatively, you can use `cron` to specify a schedule to trigger this function.
- **Handler**: the function that is called when the event is received. You can also specify [additional options](https://www.inngest.com/docs/reference/functions/create#handler) such as invoking other functions from inside this function or logging data.
- **Handler**: the function that is called when the event is received. You can also specify [additional options](/docs/reference/functions/create#handler) such as invoking other functions from inside this function or logging data.
</details>

<GuideSection show="nextpages">
Expand Down Expand Up @@ -294,15 +294,15 @@ Inngest is powered by events.
<summary><strong>Learn more: events in Inngest.</strong></summary>

It is worth mentioning here that an event-driven approach allows you to:
- Trigger one _or_ multiple functions from one event.
- Trigger one _or_ multiple functions from one event, aka [fan-out](/docs/guides/fan-out-jobs).
- Store received events for a historical record of what happened in your application.
- Use stored events to replay functions when there are issues in production.
- Interact with long-running functions by sending new events (cancel, wait for input, and other).
- Use stored events to [replay](/docs/platform/replay) functions when there are issues in production.
- Interact with long-running functions by sending new events including [waiting for input](/docs/features/inngest-functions/steps-workflows/wait-for-event) and [cancelling](/docs/features/inngest-functions/cancellation/cancel-on-events).
</details>

You will test your first event in two ways: first, by sending it directly to the Inngest UI, and then by triggering it from code.
You will test your first event in two ways: first, by sending it directly to the Inngest Dev Server UI, and then by triggering it from code.

With your Next.js and Inngest Dev Servers running, head over to Inngest Dev Server ([`http://localhost:8288`](http://localhost:8288)):
With your Next.js and Inngest Dev Server running, open the Inngest Dev Server UI: [`http://localhost:8288`](http://localhost:8288):

<img
src="/assets/docs/getting-started/nextjs-quick-start/dev-server.png"
Expand Down Expand Up @@ -387,7 +387,7 @@ Now you will trigger an event from inside your app.

## 6. Trigger from code

To run functions reliably in your app, you'll need to send an event to Inngest. Once the event is received, it is forwarded to all functions that listen to it.
To trigger Inngest functions to run in the background, you will need to send events from your application to Inngest. Once the event is received, it will automatically invoke all functions that are configured to be triggered by it.

To send an event from your code, you can use the `Inngest` client's `send()` method.

Expand Down
405 changes: 146 additions & 259 deletions pages/docs/getting-started/nodejs-quick-start.mdx

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions shared/Docs/Code.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -440,3 +440,11 @@ export function GuideSection({
}
return null;
}

export function GuideTitle() {
const context = useContext(GuideSelectorContext);
const selectedOption = context.options.find(
(o) => o.key === context.selected
);
return <>{selectedOption?.title}</>;
}
1 change: 1 addition & 0 deletions shared/Docs/mdx.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ export {
Pre as pre,
GuideSelector,
GuideSection,
GuideTitle,
} from "./Code";

export const h1: React.FC<any> = function (props) {
Expand Down

0 comments on commit 671e3b5

Please sign in to comment.