Express
Fast, unopinionated, minimalist web framework for node.
README
Fast, unopinionated, minimalist web framework for Node.js.
[![NPM Version][npm-version-image]][npm-url]
[![NPM Install Size][npm-install-size-image]][npm-install-size-url]
[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
- ```js
- const express = require('express')
- const app = express()
- app.get('/', function (req, res) {
- res.send('Hello World')
- })
- app.listen(3000)
- ```
Installation
This is a Node.js module available through the
Before installing, download and install Node.js.
Node.js 0.10 or higher is required.
If this is a brand new project, make sure to create a package.json first with
the [npm init command](https://docs.npmjs.com/creating-a-package-json-file).
Installation is done using the
[npm install command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
- ```console
- $ npm install express
- ```
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
#express on Libera Chat IRC
GitHub Organization for Official Middleware & Modules
Visit the Wiki
Google Group for discussion
Gitter for support and discussion
Quick Start
The quickest way to get started with express is to utilize the executable [express(1)](https://github.com/expressjs/generator) to generate an application as shown below:
Install the executable. The executable's major version will match Express's:
- ```console
- $ npm install -g express-generator@4
- ```
Create the app:
- ```console
- $ express /tmp/foo && cd /tmp/foo
- ```
Install dependencies:
- ```console
- $ npm install
- ```
Start the server:
- ```console
- $ npm start
- ```
View the website at: http://localhost:3000
Philosophy
The Express 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.
Express does not force you to use any specific ORM or template engine. With support for over
14 template engines via Consolidate.js,
you can quickly craft your perfect framework.
Examples
To view the examples, clone the Express repo and install the dependencies:
- ```console
- $ git clone git://github.com/expressjs/express.git --depth 1
- $ cd express
- $ npm install
- ```
Then run whichever example you want:
- ```console
- $ node examples/content-negotiation
- ```
Contributing
[![Linux Build][github-actions-ci-image]][github-actions-ci-url]
[![Windows Build][appveyor-image]][appveyor-url]
[![Test Coverage][coveralls-image]][coveralls-url]
The Express.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.
Security Issues
If you discover a security vulnerability in Express, please see Security Policies and Procedures.
Running Tests
To run the test suite, first install the dependencies, then run npm test:
- ```console
- $ npm install
- $ npm test
- ```
People
The original author of Express is TJ Holowaychuk
The current lead maintainer is Douglas Christopher Wilson
License
[appveyor-image]: https://badgen.net/appveyor/ci/dougwilson/express/master?label=windows
[appveyor-url]: https://ci.appveyor.com/project/dougwilson/express
[coveralls-image]: https://badgen.net/coveralls/c/github/expressjs/express/master
[coveralls-url]: https://coveralls.io/r/expressjs/express?branch=master
[github-actions-ci-image]: https://badgen.net/github/checks/expressjs/express/master?label=linux
[github-actions-ci-url]: https://github.com/expressjs/express/actions/workflows/ci.yml
[npm-downloads-image]: https://badgen.net/npm/dm/express
[npm-downloads-url]: https://npmcharts.com/compare/express?minimal=true
[npm-install-size-image]: https://badgen.net/packagephobia/install/express
[npm-install-size-url]: https://packagephobia.com/result?p=express
[npm-url]: https://npmjs.org/package/express
[npm-version-image]: https://badgen.net/npm/v/express