inngest / website Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 7.0 281.28 MB

Website and Documentation for Inngest

Home Page: https://www.inngest.com

JavaScript 3.04% CSS 0.84% Makefile 0.01% TypeScript 44.15% MDX 51.92% Nix 0.03% Shell 0.01%

documentation inngest

website's Introduction

Inngest Website

The Inngest website contains marketing, documentation, and blog content.

Setup

Before being able to run the app for the first time, you need to follow the steps below:

Prerequisites

Git
Node.js 18
Optional* - Join the team on Vercel with your GitHub account.

Instructions

Clone this repository
Install pnpm with Corepack by running corepack enable; corepack prepare
Install dependencies by running pnpm install
Optional* - Link local project to its Vercel project by running pnpm vercel link
Optional* - Download environment variables by running pnpm env:pull

* Running the website is possible with the default environment variables available in .env.development. Fetching other environment variables is only necessary if working on features that require them.

Developing

Running the App

Development Mode

To start the app in development mode, run the following command:

$ pnpm dev

This will start a local server that will automatically rebuild the app and refresh the page when you make changes to the code. The app will be available at http://localhost:3000.

This is how you will run the app most of the time.

Production Mode

To run the app in production mode, run the following commands in order:

# Build the app for production usage
$ pnpm build

# Start the app in production mode
$ pnpm start

This can be useful for testing the app in production mode locally.

Environment Variables

Environment variables are managed with the Vercel CLI. Use the following commands to manage them:

# Download the latest development environment variables
$ pnpm env:pull

# Add a new environment variable
$ pnpm env:add

# Remove an environment variable
$ pnpm env:rm

Check the Vercel documentation for more information.

You should never commit environment variables to the repository. If you need to add a new environment variable, add it with the pnpm env:add command and then download it with the pnpm env:pull command.

website's People

Contributors

Stargazers

Watchers

Forkers

wtachau sterv jferrettiboke brijmcq kentcdodds jerriclynsjohn valentinh

website's Issues

Fix mobile navigation scrolling

Had a look at this for about an hour and solving it looks more tedious than I first thought. The combination of Chrome's collapsing frames and our <PageBanner /> component (purple callout at top of page) being position sticky is causing so many containers to scroll.
I could probably lift the menu state up to the _app level in order to hide the page banner, but that doesn't completely solve the scrolling chrome frame issue.
I think this sort of stuff is partly why that tailwind theme uses two separate menus, Nav and MobileNav

Incorrect documentation for function concurrency

Hi,

This page has wrong documentation around function concurrency.

Verbatim:

This limits all accounts to a single execution for this function, based off of the event.data.account_id field.

Similarly in the parallel import example below, the following explanation is given:

Inngest ensures that the concurrency (1) applies to each unique value for event.data.customerId. This allows different customers to have functions running at the same exact time, but no given customer can have two functions running at once!

To my understanding, these statements are both wrong. What the concurrency parameter controls is parallel execution of steps, not of functions. So if your function consists of a single step, this works - but if you function has 3 steps, then both functions can run at the same time (just one step at a time).

This is problematic if you need the second invocation to wait for the first invocation to fully finish before starting (due to some db state which needs to be in a certain way, for example) - and IMO the docs are very confusing on this point.

Btw, is there a way to achieve function-level concurrency control, instead of steps-level?

Investigate missing hero image lines on homepage

Chrome appears to have stopped rendering the vertical lines from the hero image. Will need a bit of time to figure out what's happening here.

Convert `<a>` tags to Next's `<Link />` tag

Leaving as a future reminder:

Once we have been through the site and replaced all pages with new designs, we should swap all anchor tags to Next's built-in Link.
We can't currently complete this as when navigating via a link, Next drags the old styles across and breaks the new tailwind stuff.

Sentry example is outdated

The Sentry example uses SDK 7.x, and transactions are not used anymore. https://docs.sentry.io/platforms/javascript/guides/azure-functions/migration/v7-to-v8/v8-new-performance-api/