# feathers

> Build Better APIs, Faster than Ever.

Latest version **2.2.4** (published 2018-01-04) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install feathers
pnpm add feathers
yarn add feathers
bun add feathers
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.2.4 |
| Published | 2018-01-04 |
| First published | 2013-06-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15264 |
| Author | Feathers |
| Maintainers | ekryski, daffl |
| Keywords | feathers, REST, socket.io, realtime |

## Links

- npm: https://www.npmjs.com/package/feathers
- Repository: https://github.com/feathersjs/feathers
- Homepage: http://feathersjs.com
- Issues: https://github.com/feathersjs/feathers/issues
- npm.io page: https://npm.io/package/feathers

## Dependencies (7)

- [debug](https://npm.io/package/debug.md) ^3.1.0
- [events](https://npm.io/package/events.md) ^1.1.1
- [express](https://npm.io/package/express.md) ^4.16.1
- [uberproto](https://npm.io/package/uberproto.md) ^1.2.0
- [rubberduck](https://npm.io/package/rubberduck.md) ^1.1.1
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0
- [feathers-commons](https://npm.io/package/feathers-commons.md) ^0.8.7

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 2.2.4 (latest) — 2018-01-04
- 6.0.0-pre.11 (pre) — 2026-03-19
- 6.0.0-pre.10 — 2026-02-19
- 6.0.0-pre.9 — 2026-02-19
- 6.0.0-pre.7 — 2026-01-29
- 6.0.0-pre.5 — 2025-12-20
- 6.0.0-pre.3 — 2025-10-10
- 6.0.0-pre.2 — 2025-09-04
- 6.0.0-pre.1 — 2025-09-03
- 6.0.0-pre.0 — 2025-08-30
- 2.2.3 — 2017-10-20
- 2.2.2 — 2017-09-30
- 2.2.1 — 2017-09-25
- 2.2.0 — 2017-09-01
- 3.0.0-pre.1 — 2017-07-19
- … 39 more at https://npm.io/package/feathers/versions

## README

<img style="width: 100%; max-width: 400px;" src="http://feathersjs.com/img/feathers-logo-wide.png" alt="Feathers logo">

> __Very Important:__ THIS IS A PREVIOUS VERSION OF FEATHERS. The `feathers` package and latest version has been moved to [@feathersjs/feathers](https://www.npmjs.com/package/@feathersjs/feathers). See [docs.feathersjs.com/migrating.html](https://docs.feathersjs.com/migrating.html) for more information.

## An open source REST and realtime API layer for modern applications.

[![Greenkeeper badge](https://badges.greenkeeper.io/feathersjs/feathers.svg)](https://greenkeeper.io/)

[![Build Status](https://travis-ci.org/feathersjs/feathers.png?branch=master)](https://travis-ci.org/feathersjs/feathers)
[![Code Climate](https://codeclimate.com/github/feathersjs/feathers.png)](https://codeclimate.com/github/feathersjs/feathers)
[![Test Coverage](https://codeclimate.com/github/feathersjs/feathers/badges/coverage.svg)](https://codeclimate.com/github/feathersjs/feathers/coverage)
[![Dependency Status](https://img.shields.io/david/feathersjs/feathers.svg?style=flat-square)](https://david-dm.org/feathersjs/feathers)
[![Download Status](https://img.shields.io/npm/dm/feathers.svg?style=flat-square)](https://www.npmjs.com/package/feathers)
[![Slack Status](http://slack.feathersjs.com/badge.svg)](http://slack.feathersjs.com)

Feathers is a real-time, micro-service web framework for NodeJS that gives you control over your data via RESTful resources, sockets and flexible plug-ins.

## Getting started

You can build your first real-time and REST API in just 4 commands:

```bash
$ npm install -g feathers-cli
$ mkdir my-new-app
$ cd my-new-app/
$ feathers generate app
$ npm start
```

To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers docs](http://docs.feathersjs.com).

## See it in action

Here is all the code you need to create a RESTful, real-time message API that uses an in-memory data store:

```js
// app.js
const feathers = require('feathers');
const rest = require('feathers-rest');
const socketio = require('feathers-socketio');
const memory = require('feathers-memory');
const bodyParser = require('body-parser');
const handler = require('feathers-errors/handler');

// A Feathers app is the same as an Express app
const app = feathers();

// Add REST API support
app.configure(rest());
// Configure Socket.io real-time APIs
app.configure(socketio());
// Parse HTTP JSON bodies
app.use(bodyParser.json());
// Parse URL-encoded params
app.use(bodyParser.urlencoded({ extended: true }));
// Register our memory "messages" service
app.use('/messages', memory());
// Register a nicer error handler than the default Express one
app.use(handler());
// Start the server
app.listen(3000);
```

Then run

```
npm install feathers feathers-rest feathers-socketio feathers-errors feathers-memory body-parser
node app
```

and go to [http://localhost:3000/messages](http://localhost:3000/messages). That's it! There's a lot more you can do with Feathers including; using a real database, authentication, authorization, clustering and more! Head on over to [the Feathers docs](http://docs.feathersjs.com) to see just how easy it is to build scalable real-time apps.

## Documentation

The [Feathers docs](http://docs.feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers.

## Examples

Each plugin has it's own minimal example in the repo. To see a more complex example go to [feathersjs/feathers-chat](https://github.com/feathersjs/feathers-chat).

## Security

We :heart: the community and take security very seriously. No one wants their app hacked. If you have come across a security concern please [report it responsibly](https://docs.feathersjs.com/security#where-should-i-report-security-issues). Visit the [Security section](https://docs.feathersjs.com/SECURITY.html) of the docs to learn more about how you can make sure your app is secure.

## Long Term Support Schedule

We are going to be following along with the Node.js long term support cycle. As a result **we have dropped official support for node v0.10, v0.12, and iojs versions**. Feathers still works on those versions but we're not going to ensure it will going forward.

We will be supporting Node.js v4 until **2018-04-01**.
We will be supporting Node.js v6 until **2019-04-18**.

## License

[MIT](LICENSE)

## Authors

[Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)

---
_Source: https://npm.io/package/feathers · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
