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.
lib
test
.gitignore
.jshintrc
.travis.yml
LICENSE
changelog.md
contributing.md
package.json
readme.md

readme.md

Feathers logo

Build Better APIs, Faster than Ever

NPM

Build Status Code Climate Join the chat at https://gitter.im/feathersjs/feathers

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

Visit the website at feathersjs.com to read the Getting started guide or learn how to build real-time applications with jQuery, Angular, React, CanJS, iOS, Android - you name it - and Feathers as the backend in our guides.

A MongoDB REST and real-time API

Want to see it in action? Here is a full REST and real-time todo API that uses MongoDB:

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

var app = feathers();
var todoService = mongodb({
  db: 'feathers-demo',
  collection: 'todos'
});

app.configure(feathers.rest())
  .configure(feathers.socketio())
  .use(bodyParser.json())
  .use('/todos', todoService)
  .use('/', feathers.static(__dirname))
  .listen(3000);

Then run

npm install feathers feathers-mongodb body-parser
node app

and go to http://localhost:3000/todos. That's all the code you need to have a full real-time CRUD API.

Don't want to use MongoDB? Feathers has plugins for many other databases and you can easily write your own adapters.

License

MIT

Authors

Something went wrong with that request. Please try again.