https://github.com/mcansh/remix-fastify

Fastify server request handler for Remix
https://github.com/mcansh/remix-fastify

fastify fastify-plugin fastifyjs http nodejs remix-run remix-server-adapter web-server

Last synced: about 15 hours ago
JSON representation

Fastify server request handler for Remix

• Host: GitHub
• URL: https://github.com/mcansh/remix-fastify
• Owner: mcansh
• License: mit
• Created: 2021-08-25T01:46:23.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T16:17:37.000Z (3 months ago)
• Last Synced: 2024-10-29T17:13:14.905Z (3 months ago)
• Topics: fastify, fastify-plugin, fastifyjs, http, nodejs, remix-run, remix-server-adapter, web-server
• Language: TypeScript
• Homepage: https://remix-fastify.onrender.com
• Size: 3.41 MB
• Stars: 193
• Watchers: 5
• Forks: 29
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Remix Fastify

Use [Remix](https://remix.run) with [Fastify](http://fastify.io)

## Quick Start

These are the currently available templates that you can get jump started with:

- Using the Remix Vite plugin (recommended)

  ```sh

  npx create-remix@latest --template mcansh/remix-fastify/examples/vite

  ```

- The basic example using the old Remix compiler

  ```sh

  npx create-remix@latest --template mcansh/remix-fastify/examples/basic

  ```

## Add to existing remix vite app

### Install dependencies

```shell

pnpm add @mcansh/remix-fastify fastify source-map-support get-port chalk @fastify/{middie,static}

```

### Install dev dependencies

```shell

pnpm add -D @types/source-map-support tsx

```

in the root of your project create a server directory and add index.ts

`server/index.ts`

```ts

import chalk from "chalk";

import { remixFastify } from "@mcansh/remix-fastify";

import { fastify } from "fastify";

import sourceMapSupport from "source-map-support";

import getPort, { portNumbers } from "get-port";

sourceMapSupport.install();

let app = fastify();

await app.register(remixFastify);

let host = process.env.HOST || "127.0.0.1";

let desiredPort = Number(process.env.PORT) || 3000;

let portToUse = await getPort({

  port: portNumbers(desiredPort, desiredPort + 100),

});

let address = await app.listen({ port: portToUse, host });

if (portToUse !== desiredPort) {

  console.warn(

    chalk.yellow(

      `⚠️ Port ${desiredPort} is not available, using ${portToUse} instead.`,

    ),

  );

}

console.log(chalk.green(`✅ app ready: ${address}`));

```

Update the `package.json` dev, start and build commands

```json

"build": "remix vite:build && tsc --project ./tsconfig.server.json",

"dev": "cross-env NODE_ENV=development tsx --watch-path ./server/index.ts ./server/index.ts",

"start": "cross-env NODE_ENV=production node ./server/index.js",

```

Add the `tsconfig.server.json` file to the root of the project

```json

{

  "$schema": "https://json.schemastore.org/tsconfig",

  "extends": "./tsconfig.json",

  "include": ["./server/**/*.ts"],

  "exclude": ["node_modules"],

  "compilerOptions": {

    "noEmit": false,

    "outDir": "./server"

  }

}

```

run `pnpm dev` to test that the server starts