feathers README

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

Feathers - The API and real-time application framework

CI Download Status Discord

Feathers is a full-stack framework for creating web APIs and real-time applications with TypeScript or JavaScript.

Feathers can interact with any backend technology, supports many databases out of the box and works with any frontend like React, VueJS, Angular, React Native, Android or iOS.

Getting started

Get started with just three commands:

$ npm create feathers my-new-app
$ cd my-new-app
$ npm run dev

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

Contributing

To start developing, clone this repository, then run:

cd feathers
npm install

To run all tests run

npm test

Individual tests can be run in the module you are working on:

cd packages/feathers
npm test

License

Copyright (c) 2024 Feathers contributors

Licensed under the MIT license.

feathers (feathersjs/feathers)

Searching Database…

15.3K ·GitHub
What is this?Feathers is a full-stack framework for building web APIs and real-time applications with TypeScript or JavaScript, working with any backend technology and any frontend like React, Vue, Angular or React Native.
Is it a framework or just a library?It's a full framework: it provides services, hooks, authentication and real-time events on top of Express-like architecture, not just a single-purpose utility.
How do I get a new Feathers app running?You can get started with just three commands, using the Feathers CLI to generate a new app and then run it.
Do I need Node.js installed first?Yes, Feathers requires Node.js version 20 or newer.
Do I need a specific database to use it?No, Feathers isn't tied to one database or backend; it works with many databases out of the box and can interact with any backend technology.
Which frontend frameworks does it support?Any frontend works, including React, Vue.js, Angular, React Native, and native Android or iOS clients.
What makes real-time support special in Feathers?Feathers automatically pushes real-time events (like created, updated, removed) over websockets whenever data changes through its services, without extra plumbing.
How is Feathers organized as a project?It's a monorepo of packages (managed with Lerna) covering core, transports, authentication, database adapters and client libraries that you combine as needed.
Can I use the same backend code with REST and websockets?Yes, Feathers services are transport-agnostic, so the same service logic can be exposed over REST and real-time websocket connections simultaneously.
Creator
feathersjs
Size
44.4 MB
Stars
15.3K
Age
14y
Commits · 90 Days