Unverified Commit 6a8010db authored by Joel Hooks's avatar Joel Hooks Committed by GitHub

examples: Add inngest next.js example (#56049)

Co-authored-by: 's avatarLee Robinson <me@leerob.io>
Co-authored-by: 's avatarkodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
parent ee9a13aa
...@@ -240,7 +240,7 @@ docs](https://developers.google.com/maps/documentation/embed/embedding-map). ...@@ -240,7 +240,7 @@ docs](https://developers.google.com/maps/documentation/embed/embedding-map).
| `allowfullscreen` | Optional | Property to allow certain map parts to go full screen. | | `allowfullscreen` | Optional | Property to allow certain map parts to go full screen. |
| `loading` | Optional | Defaults to lazy. Consider changing if you know your embed will be above the fold. | | `loading` | Optional | Defaults to lazy. Consider changing if you know your embed will be above the fold. |
| `q` | Optional | Defines map marker location. _This may be required depending on the map mode_. | | `q` | Optional | Defines map marker location. _This may be required depending on the map mode_. |
| `center` | Optional | Defines the center of the map view. | | `center` | Optional | Defines the center of the map view. |
| `zoom` | Optional | Sets initial zoom level of the map. | | `zoom` | Optional | Sets initial zoom level of the map. |
| `maptype` | Optional | Defines type of map tiles to load. | | `maptype` | Optional | Defines type of map tiles to load. |
| `language` | Optional | Defines the language to use for UI elements and for the display of labels on map tiles. | | `language` | Optional | Defines the language to use for UI elements and for the display of labels on map tiles. |
......
INNGEST_EVENT_KEY=your-event-key
INNGEST_SIGNING_KEY=your-signing-key
\ No newline at end of file
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
/node_modules
/.pnp
.pnp.js
# testing
/coverage
# next.js
/.next/
/out/
# production
/build
# misc
.DS_Store
*.pem
# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# local env files
.env*.local
# vercel
.vercel
# typescript
*.tsbuildinfo
next-env.d.ts
# Next.js and Inngest Example
This is an example of how to use [Inngest](https://inngest.com) to easily add durable work flows to your Next.js application. It keeps things simple:
- Bare bones examples with a single button UI that triggers an event
- Runs the Inngest dev server locally for immediate feedback
## Deploy your own
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/next.js/tree/canary/examples/inngest&project-name=inngest&repository-name=inngest)
To full deploy you'll need an [Inngest Cloud account](https://inngest.com) and the [Vercel Inngest integration](https://vercel.com/integrations/inngest) configured.
## How to use
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), [pnpm](https://pnpm.io), or [Bun](https://bun.sh/docs/cli/bunx) to bootstrap the example:
```bash
npx create-next-app --example inngest inngest-app
```
```bash
yarn create next-app --example inngest inngest-app
```
```bash
pnpm create next-app --example inngest inngest-app
```
```bash
bunx create-next-app --example inngest inngest-app
```
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
## Notes
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
The Inngest dev server will be running at [http://localhost:8288](http://localhost:8288). It can take a few seconds to start up.
/** @type {import('next').NextConfig} */
const nextConfig = {}
module.exports = nextConfig
{
"private": true,
"scripts": {
"dev": "concurrently \"npm:dev:*\"",
"dev:next": "next dev",
"dev:inngest": "npx inngest-cli@latest dev",
"build": "next build",
"start": "next start"
},
"dependencies": {
"inngest": "^3.4.1",
"next": "latest",
"react": "18.2.0",
"react-dom": "18.2.0"
},
"devDependencies": {
"@types/node": "20.7.0",
"@types/react": "18.2.23",
"@types/react-dom": "18.2.7",
"concurrently": "^8.2.1",
"encoding": "^0.1.13",
"typescript": "5.2.2"
}
}
import { serve } from 'inngest/next'
import { inngest } from '@/inngest/inngest.client'
import { helloWorld } from '@/inngest/functions/hello-world'
export const { GET, POST, PUT } = serve(inngest, [helloWorld])
import type { Metadata } from 'next'
export const metadata: Metadata = {
title: 'Next.js Inngest Example',
description: 'Generated by create next app',
}
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
import { inngest } from '@/inngest/inngest.client'
import { redirect } from 'next/navigation'
export default function Home() {
async function triggerInngestEvent() {
'use server'
await inngest.send({
name: 'test/hello.world',
data: {
message: 'Hello from Next.js!',
},
})
redirect('http://localhost:8288/stream')
}
return (
<main>
<div>
<form action={triggerInngestEvent}>
<button type="submit">Trigger Your Inngest Function</button>
</form>
</div>
</main>
)
}
import { inngest } from '../inngest.client'
export const helloWorld = inngest.createFunction(
{ id: 'hello-world', name: 'Hello World' },
{ event: 'test/hello.world' },
async ({ event, step }) => {
await step.sleep('sleep for a second', '1s')
return { event, body: event.data.message }
}
)
import { Inngest } from 'inngest'
// Create a client to send and receive events
export const inngest = new Inngest({ name: 'Basic Inngest Application' })
{
"compilerOptions": {
"target": "es5",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve",
"incremental": true,
"plugins": [
{
"name": "next"
}
],
"paths": {
"@/*": ["./src/*"]
}
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
"exclude": ["node_modules"]
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment