expressjs/express

expressjs/express

README

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

  1. ``` js
  2. const express = require('express')
  3. const app = express()

  5. app.get('/', function (req, res) {
  6.   res.send('Hello World')
  7. })

  9. app.listen(3000)
  10. ```

Installation


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

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.

Installation is done using the npm install command :

  1. ``` session
  2. $ npm install express
  3. ```

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 ]
#express on Libera Chat IRC
GitHub Organization for Official Middleware & Modules
Visit the Wiki
Google Group for discussion
Gitter for support and discussion

PROTIPBe sure to read Migrating from 3.x to 4.x as well as New features in 4.x.

Quick Start


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

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

  1. ``` session
  2. $ npm install -g express-generator@4
  3. ```

Create the app:

  1. ``` session
  2. $ express /tmp/foo && cd /tmp/foo
  3. ```

Install dependencies:

  1. ``` session
  2. $ npm install
  3. ```

Start the server:

  1. ``` session
  2. $ npm start
  3. ```

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:

  1. ``` session
  2. $ git clone git://github.com/expressjs/express.git --depth 1
  3. $ cd express
  4. $ npm install
  5. ```

Then run whichever example you want:

  1. ``` session
  2. $ node examples/content-negotiation
  3. ```

Contributing


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 :

  1. ``` session
  2. $ npm install
  3. $ npm test
  4. ```

People


The original author of Express is TJ Holowaychuk

The current lead maintainer is Douglas Christopher Wilson

List of all contributors

License


MIT