express README

The project's README from github.com/expressjs/express. As one markdown file: README.md.

Express Logo

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

Table of contents

NPM Version NPM Downloads Linux Build Test Coverage OpenSSF Scorecard Badge

import express from 'express'

const app = express()

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

app.listen(3000, () => {
  console.log('Server is running on http://localhost: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 express

Follow our installing guide for more information.

Features

Docs & Community

PROTIP Be sure to read the migration guide to v5

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:

npm install -g express-generator@4

Create the app:

express /tmp/foo && cd /tmp/foo

Install dependencies:

npm install

Start the server:

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 @ladjs/consolidate, you can quickly craft your perfect framework.

Examples

To view the examples, clone the Express repository:

git clone https://github.com/expressjs/express.git --depth 1 && cd express

Then install the dependencies:

npm install

Then run whichever example you want:

node examples/content-negotiation

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.

This project has a Code of Conduct. By participating, you are expected to uphold this code.

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:

npm install

Then run npm test:

npm test

Current project team members

For information about the governance of the express.js project, see GOVERNANCE.md.

The original author of Express is TJ Holowaychuk

List of all contributors

TC (Technical Committee)

TC emeriti members

TC emeriti members

Triagers

Triagers emeriti members

Emeritus Triagers

License

MIT

express (expressjs/express)

Searching Database…

69.6K ·GitHub
这是什么?Express 是一个快速、灵活且极简的 Node.js Web 框架,可用于搭建 HTTP 服务器、API 和 Web 应用。
它是框架还是库?它是一个框架:提供路由、HTTP 辅助工具和视图系统,但不会强制你使用某种 ORM 或模板引擎,你可以在它之上自由搭配自己的技术栈。
我该怎么开始用它?先安装 Node.js 18+,运行 npm init 创建 package.json,再执行 npm install express。你也可以使用 express(1) 生成器命令,快速搭建完整应用、安装依赖并启动服务器。
安装前我需要准备什么?你需要 Node.js 18 或更高版本以及 npm;Express 本身依赖一些小型工具包,比如 body-parser、cookie、etag 和 finalhandler。
它自带模板引擎或 ORM 吗?没有。Express 保持极简,你可以通过 @ladjs/consolidate 接入 14 种以上受支持的模板引擎,也可以接入任何你喜欢的 ORM 或数据库。
它适合做哪类应用?Express 适合用于单页应用的后端、完整网站、混合型应用以及对外开放的 HTTP API。
除了路由,它还有哪些核心功能?稳健的路由、重定向和缓存等 HTTP 辅助功能、内容协商、很高的测试覆盖率,以及可以快速生成新应用的命令行工具。
我怎么试用示例应用?克隆 Express 仓库,用 npm 安装依赖,然后直接运行 examples 文件夹中的任意示例脚本。
Express 还在更新维护吗,还是已经是遗留项目了?还在积极维护。项目有持续集成(ci.yml、codeql.yml)、Scorecard 检查,还提供了迁移到 Express v5 的指南。
What are similar projects?koa, hapi, martini, flask, Rocket, Slim, multer, fiber
Creator
expressjs
Size
9.8 MB
Stars
69.6K
Age
17y
Commits · 90 Days