Skip to content
A minimalist real-time JavaScript framework for tomorrow's apps.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
src Explicitly import /index files to work with Steal.
test Reorganizing packages to not load Express and work with non-Node and …
.babelrc Migration to ES6 and API providers in separate modules
.gitignore Migration to ES6 and API providers in separate modules
.jshintrc Migration to ES6 and API providers in separate modules
.npmignore
.travis.yml adding v0.12.x build directive
LICENSE moar badges. Also adding LICENSE and authors for consistency
changelog.md Updating changelog for v1.3.0
client.js
contributing.md Migration to ES6 and API providers in separate modules
package.json 2.0.0
readme.md Tiny readme tweak before 2.0 final

readme.md

Feathers logo

A minimalist real-time framework for tomorrow's apps.

NPM

Build Status Code Climate Slack Status

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 API in just 4 commands:

$ npm install -g yo generator-feathers
$ mkdir my-new-app
$ cd my-new-app/
$ yo feathers
$ npm start

To learn more about Feathers visit the website at feathersjs.com or jump right into the Feathers docs.

See it in action

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

// app.js
var feathers = require('feathers');
var rest = require('feathers-rest');
var socketio = require('feathers-socketio');
var memory = require('feathers-memory');
var bodyParser = require('body-parser');

// A Feathers app is the same as an Express app
var 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 "todos" service
app.use('/todos', memory());
// Start the server
app.listen(3000);

Then run

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

and go to http://localhost:3000/todos. 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 to see just how easy it is to build scalable real-time apps.

License

MIT

Authors

Feathers contributors

Something went wrong with that request. Please try again.