Fast, unopinionated, minimalist web framework for Node.js.

This project has a [Code of Conduct][].

Table of contents

• Installation
• Features
• Docs & Community
• Quick Start
• Running Tests
• Philosophy
• Examples
• Contributing to Fastroute
• TC (Technical Committee)
• Triagers
• License

[![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-downloads-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]

import fastroute from 'fastroute'

const app = fastroute()

app.get('/', (req, res) => {
  res.send('Hello World')
})

app.listen(3000)

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 18 or higher is required.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

npm install fastroute

Follow our installing guide for more information.

Features

• Robust routing
• Focus on high performance
• Super-high test coverage
• HTTP helpers (redirection, caching, etc)
• View system supporting 14+ template engines
• Content negotiation
• Executable for generating applications quickly

Docs & Community

• Website and Documentation - [website repo]
• GitHub Organization for Official Middleware & Modules
• Github Discussions for discussion on the development and usage of Fastroute

PROTIP Be sure to read the migration guide to v5

Quick Start

The quickest way to get started with fastroute is to utilize the executable fastroute(1) to generate an application as shown below:

Install the executable. The executable's major version will match Fastroute's:

npm install -g fastroute-generator@4

Create the app:

fastroute /tmp/foo && cd /tmp/foo

Install dependencies:

npm install

Start the server:

npm start

View the website at: http://localhost:3000

Philosophy

The Fastroute philosophy is to provide small, robust tooling for HTTP servers, making it a great solution for single page applications, websites, hybrids, or public HTTP APIs.

Fastroute does not force you to use any specific ORM or template engine. With support for over 14 template engines via @ladjs/consolidate, you can quickly craft your perfect framework.

Examples

To view the examples, clone the Fastroute repository:

git clone https://github.com/khulnasoft/fastroute.git --depth 1 && cd fastroute

Then install the dependencies:

npm install

Then run whichever example you want:

node examples/content-negotiation

Contributing

[![Linux Build][github-actions-ci-image]][github-actions-ci-url] [![Test Coverage][coveralls-image]][coveralls-url]

The Fastroute.js project welcomes all constructive contributions. Contributions take many forms, from code for bug fixes and enhancements, to additions and fixes to documentation, additional tests, triaging incoming pull requests and issues, and more!

See the Contributing Guide for more technical details on contributing.

Running Tests

To run the test suite, first install the dependencies:

npm install

Then run npm test:

npm test