mirror of
https://github.com/feathersjs/feathers.git
synced 2026-01-25 15:23:13 +00:00
Appending `nsp check` to test script.
Build Better APIs, Faster than Ever
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
import feathers from 'feathers';
import rest from 'feathers-rest';
import socketio from 'feathers-socketio';
import mongodb from 'feathers-mongodb';
import bodyParser from 'body-parser';
const app = feathers();
const todoService = mongodb({
db: 'feathers-demo',
collection: 'todos'
});
app.configure(rest())
.configure(socketio())
.use(bodyParser.json())
.use('/todos', todoService)
.use('/', feathers.static(__dirname))
.listen(3000);
Then run
npm install feathers feathers-rest feathers-socketio 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
Authors
Languages
TypeScript
96.2%
HTML
3.5%
JavaScript
0.3%


