https://github.com/fastly/serve-vercel-build-output

A runtime environment that executes output that targets the Vercel Build Output API on Fastly Compute
https://github.com/fastly/serve-vercel-build-output

compute-library fastly-oss-tier2

Last synced: 3 months ago
JSON representation

A runtime environment that executes output that targets the Vercel Build Output API on Fastly Compute

• Host: GitHub
• URL: https://github.com/fastly/serve-vercel-build-output
• Owner: fastly
• License: mit
• Created: 2023-01-30T02:57:22.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-30T14:29:54.000Z (5 months ago)
• Last Synced: 2024-10-17T00:45:30.854Z (3 months ago)
• Topics: compute-library, fastly-oss-tier2
• Language: TypeScript
• Homepage:
• Size: 964 KB
• Stars: 5
• Watchers: 13
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
## Serve Vercel Build Output (v3) on Fastly Compute

> NOTE: `@fastly/serve-vercel-build-output` is provided as a Fastly Labs product. Visit the [Fastly Labs](https://www.fastlylabs.com/) site for terms of use.

This library's goal is to provide a runtime environment that executes output that targets the [Vercel Build Output API](https://vercel.com/docs/build-output-api/v3).

Vercel's Build Output API is a file-system-based specification for a directory structure that represents a Vercel deployment. It includes static files, functions, and a configuration file that expresses routing and internationalization rules.

While it's not (currently) possible to simulate it 100%, it is able to run a wide variety of programs, including those written for [Next.js v12.3 and v13.x](https://nextjs.org).

Current support includes:

* The standard `.vercel` directory containing output that targets Vercel's Build Output API

* Static files

* Functions that target the Vercel Edge Runtime

* The following features of config.json:

  * Routing

  * Overrides

  * Wildcards

  * Image Optimization

## Usage

This library is typically used with [`@fastly/next-compute-js`](https://github.com/fastly/next-compute-js) (v2).

See `@fastly/next-compute-js` for more details.

## Issues

If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug]

using the bug report template.

[bug]: https://github.com/fastly/serve-vercel-build-output/issues/new?labels=bug

### Security issues

Please see our [SECURITY.md](./SECURITY.md) for guidance on reporting security-related issues.

## License

[MIT](./LICENSE).