Skip to content
Get packs

Guide · Open source

How to use Feathers: install, run and build an API

Updated · written with AI from the project's own documentation and checked against our catalogue data

Feathers is an open-source, MIT-licensed framework for building the server side of web and real-time applications in TypeScript or JavaScript. This guide is for developers who already know some Node.js and want to create a starter project and connect it to a client. By the end you will know the prerequisites, the three commands to start a new app, and what the project supports.

Feathersfeathersjs/feathers · ★ 15.3k · MIT

Quick start

  1. 1Check prerequisites. Make sure Node.js and npm are installed on your machine.
  2. 2Create the app. Run npm create feathers my-new-app in the folder where you want the project.
  3. 3Open the project. Change into the new folder with cd my-new-app.
  4. 4Start the dev server. Run npm run dev to start the development server.
  5. 5Read the guides. Visit feathersjs.com/guides to learn how to build services and connect a client.

What Feathers is and who it is for

Feathers is a full-stack framework for creating web APIs and real-time applications. According to its README, it can interact with any backend technology, supports many databases out of the box, and works with frontends such as React, VueJS, Angular, React Native, Android or iOS.

It is aimed at developers who want to build the server side of an app and connect it to a client. It is a code framework, so you write server code rather than configuring it in a visual tool.

  • JavaScript or TypeScript developers building a web API
  • Teams that want real-time features in a Node.js backend
  • Developers building clients in React, Vue, Angular or React Native who need a backend

What you need before you install Feathers

The README lists Node.js and npm as the prerequisites. The guide assumes familiarity with Node.js tooling, so basic comfort with the terminal and npm is expected.

  • Node.js
  • npm

Create and start a new Feathers app

The README shows that you can get started with three commands. Run the first to generate a project named my-new-app, move into its folder, then start the development server.

The README also points to the official guides at feathersjs.com/guides for next steps.

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

Contribute to the Feathers source code

If you want to work on Feathers itself rather than build an app with it, the README describes cloning the repository and installing dependencies with npm. Tests run with npm test, and individual packages can be tested from their own folder.

  • Clone the repository, then run npm install in the feathers folder
  • Run all tests with npm test
  • Run tests for one package from its folder, for example packages/feathers
cd feathers npm install npm test

Common use cases for Feathers

The README does not list detailed examples, so the uses below follow directly from its stated goals: building web APIs, real-time features and connecting clients.

  • Build a web API in TypeScript or JavaScript
  • Add real-time features to a Node.js backend
  • Provide a backend for a React, Vue, Angular or React Native client

What people use it for

  • Building a web API in TypeScript or JavaScript
  • Adding real-time features to a Node.js backend
  • Serving a React, Vue, Angular or React Native frontend
  • Generating a starter project with a single command

Frequently asked questions

Is Feathers free to use?

Yes. The README states that Feathers is licensed under the MIT license, which is a permissive open-source licence. The source does not mention pricing for any hosted service.

What do I need to install Feathers?

The README lists Node.js and npm as prerequisites. Once they are installed, you can create a project with npm create feathers my-new-app.

How do I start a new Feathers project?

Run npm create feathers my-new-app, then cd into my-new-app and run npm run dev. The README presents these as the three commands needed to get started.

Which frontends does Feathers work with?

According to the README, Feathers works with frontends such as React, VueJS, Angular, React Native, Android and iOS.

Can I use Feathers without JavaScript or TypeScript?

No. The README describes Feathers as a framework for TypeScript or JavaScript, so projects that must use a non-Node.js backend language are not a good fit.

How does Feathers compare to Express, NestJS, Fastify or Koa?

The source does not compare these projects, so this guide cannot rank them. Feathers is a full-stack framework for APIs and real-time apps, and those listed are alternatives to consider for backend work.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Feathers suits JavaScript or TypeScript developers who want a Node.js backend with real-time features and a quick starter project. It is not suitable for non-programmers, for anyone wanting a no-code tool, or for projects that must use a non-JavaScript backend language.

Install options & downloads