Skip to content

Commit

Permalink
Node.js quick start (#996)
Browse files Browse the repository at this point in the history
* WIP Node.js quick start

* Update screenshots and framework specific instructions

* Add Node quick start to the docs homepage

* Refresh Next.js quick start with Node QS content (#997)

* Fix link
  • Loading branch information
djfarrelly authored Nov 18, 2024
1 parent 392e127 commit 6db7202
Show file tree
Hide file tree
Showing 17 changed files with 574 additions and 95 deletions.
144 changes: 63 additions & 81 deletions pages/docs/getting-started/nextjs-quick-start.mdx

Large diffs are not rendered by default.

474 changes: 474 additions & 0 deletions pages/docs/getting-started/nodejs-quick-start.mdx

Large diffs are not rendered by default.

36 changes: 23 additions & 13 deletions pages/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import GoIcon from 'src/shared/Icons/Go';
import {
RiCloudLine,
RiNextjsFill,
RiNodejsFill,
RiGitPullRequestFill,
RiGuideFill,
} from "@remixicon/react";
Expand All @@ -13,17 +14,17 @@ export const hidePageSidebar = true;

# Inngest Documentation

Inngest is an event-driven durable execution platform that allows you to run fast, reliable code on any platform, without managing queues, infra, or state.
Inngest is an event-driven durable execution platform that allows you to run fast, reliable code on any platform, without managing queues, infra, or state.


Write functions in TypeScript, Python or Go to power background and scheduled jobs, with steps built in. We handle the backend infra, queueing, scaling, concurrency, throttling, rate limiting, and observability for you.

## Get started


<CardGroup cols={3}>
<CardGroup cols={2}>

<Card
<Card
href={"/docs/getting-started/nextjs-quick-start"}
title={"Next.js"}
icon={<RiNextjsFill className="text-basis h-8 w-8"/>}
Expand All @@ -32,7 +33,16 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo
Add queueing, events, crons, and step functions to your Next app on any cloud provider.
</Card>

<Card
<Card
href={"/docs/getting-started/nodejs-quick-start"}
title={"Node.js"}
icon={<RiNodejsFill className="text-basis h-8 w-8"/>}
iconPlacement="top"
>
Write durable step functions in any Node.js app and run on servers or serverless.
</Card>

<Card
href={"/docs/getting-started/python-quick-start"}
title={"Python"}
icon={<PythonIcon className="text-basis h-8 w-8"/>}
Expand All @@ -42,7 +52,7 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo
</Card>


<Card
<Card
href={"https://pkg.go.dev/github.com/inngest/[email protected]"}
title={"Go"}
icon={<GoIcon className="text-basis h-8 w-8"/>}
Expand All @@ -56,7 +66,7 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo

<CardGroup cols={1} className="my-10 px-12">

<Card
<Card
title={"Write reliable workflows"}
>
<div className="flex flex-col md:flex-row justify-between">
Expand All @@ -82,15 +92,15 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo

<CardGroup cols={3}>

<Card
<Card
href={"/docs/guides/user-defined-workflows"}
title={"User-defined Workflows"}
iconPlacement="top"
>
Users today are demanding customization and integrations. Discover how to build a Workflow Engine for your users using Inngest.
</Card>

<Card
<Card
href={"/docs/examples/ai-agents-and-rag"}
title={"AI Agents and RAG"}
iconPlacement="top"
Expand All @@ -99,7 +109,7 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo
</Card>


<Card
<Card
href={"/docs/examples/email-sequence"}
title={"Email sequence"}
iconPlacement="top"
Expand All @@ -115,7 +125,7 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo

<CardGroup cols={2}>

<Card
<Card
href={"/docs/features/inngest-functions/steps-workflows"}
title={"Function steps"}
icon={<RiGuideFill className="text-basis h-4 w-4"/>}
Expand All @@ -124,23 +134,23 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo
</Card>


<Card
<Card
href={"/docs/guides/flow-control"}
title={"Flow Control"}
icon={<RiGitPullRequestFill className="rotate-90 text-basis h-4 w-4" />}
>
Add multi-tenant aware prioritization, concurrency, throttling, batching, and rate limiting capabilities to your Inngest Functions.
</Card>

<Card
<Card
href={"/docs/platform/monitor/observability-metrics"}
title={"Inngest Platform"}
icon={<InngestIcon className="text-basis h-4 w-4"/>}
>
Monitor your deployments with Metrics and Function & Events Logs.
</Card>

<Card
<Card
href={"/docs/platform/deployment"}
title={"Deploy your Inngest Functions"}
icon={<RiCloudLine className="text-basis h-4 w-4"/>}
Expand Down
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}</>;
}
3 changes: 2 additions & 1 deletion 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 Expand Up @@ -462,7 +463,7 @@ export function Card<T extends React.ElementType = "div">({
)}
<h2
className={clsx(
"font-semibold text-[#2E2E2E] text-sm dark:text-carbon-50",
"mb-px font-semibold text-[#2E2E2E] text-sm dark:text-carbon-50",
{
"text-base": !!props.href,
"text-xl": !props.href,
Expand Down
4 changes: 4 additions & 0 deletions shared/Docs/navigationStructure.ts
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,10 @@ const sectionHome: (NavGroup | NavLink)[] = [
title: "Next.js",
href: "/docs/getting-started/nextjs-quick-start",
},
{
title: "Node.js",
href: "/docs/getting-started/nodejs-quick-start",
},
{
title: "Python",
href: "/docs/getting-started/python-quick-start",
Expand Down

0 comments on commit 6db7202

Please sign in to comment.