/compute-starter-kit-typescript

A simple Fastly starter kit for Typescript

Primary LanguageTypeScriptMIT LicenseMIT

Default Starter Kit For TypeScript

Deploy to Fastly

Get to know the Fastly Compute environment with a basic starter that demonstrates routing, simple synthetic responses and code comments that cover common patterns.

For more details about other starter kits for Compute, see the Fastly Documentation Hub

Features

  • Allow only requests with particular HTTP methods
  • Match request URL path and methods for routing
  • Build synthetic responses at the edge

Understanding the code

This starter is intentionally lightweight, and requires no dependencies aside from the @fastly/js-compute npm package. It will help you understand the basics of processing requests at the edge using Fastly. This starter includes implementations of common patterns explained in our using Compute and VCL migration guides.

The starter doesn't require the use of any backends. Once deployed, you will have a Fastly service running on Compute that can generate synthetic responses at the edge.

The template uses TypeScript to compile source files in ./src into JS files in ./build, which are then wrapped into ./bin/index.wasm using the js-compute-runtime CLI tool bundled with the @fastly/js-compute npm package, and bundled into a .tar.gz file ready for deployment to Compute.

Running the application

To create an application using this starter kit, create a new directory for your application and switch to it, and then type the following command:

npm create @fastly/compute@latest -- --language=typescript --default-starter-kit

To build and run your new application in the local development environment, type the following command:

npm run start

To build and deploy your application to your Fastly account, type the following command. The first time you deploy the application, you will be prompted to create a new service in your account.

npm run deploy

Security issues

Please see our SECURITY.md for guidance on reporting security-related issues.