## File: README.md
---
[](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
[](https://www.npmjs.com/package/@feathersjs/feathers)
[](https://discord.gg/qa8kez8QBx)
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:
```bash
$ npm create feathers my-new-app
$ cd my-new-app
$ npm run dev
```
To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](https://feathersjs.com/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](https://github.com/feathersjs/feathers/graphs/contributors)
Licensed under the [MIT license](LICENSE).
---
## File: Readme.md
## A framework for real-time applications and REST APIs with JavaScript and TypeScript
[](https://github.com/feathersjs/feathers/actions?query=workflow%3A%22Node.js+CI%22)
[](https://codeclimate.com/github/feathersjs/feathers/maintainability)
[](https://codeclimate.com/github/feathersjs/feathers/test_coverage)
[](https://www.npmjs.com/package/@feathersjs/feathers)
[](http://slack.feathersjs.com)
[](https://t.me/featherjs)
Feathers is a lightweight web-framework for creating real-time applications and REST APIs using JavaScript or TypeScript.
Feathers can interact with any backend technology, supports over a dozen databases and works with any frontend technology like React, VueJS, Angular, React Native, Android or iOS.
## Getting started
You can build your first real-time and REST API in just 4 commands:
```bash
$ npm install @feathersjs/cli
$ mkdir my-new-app
$ cd my-new-app/
$ feathers generate app
$ npm start
```
To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](http://docs.feathersjs.com/guides).
## Support
### Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/feathers#sponsor)]
[](https://opencollective.com/feathers/sponsor/0/website)
[](https://opencollective.com/feathers/sponsor/1/website)
[](https://opencollective.com/feathers/sponsor/2/website)
[](https://opencollective.com/feathers/sponsor/3/website)
[](https://opencollective.com/feathers/sponsor/4/website)
[](https://opencollective.com/feathers/sponsor/5/website)
[](https://opencollective.com/feathers/sponsor/6/website)
[](https://opencollective.com/feathers/sponsor/7/website)
[](https://opencollective.com/feathers/sponsor/8/website)
[](https://opencollective.com/feathers/sponsor/9/website)
[](https://opencollective.com/feathers/sponsor/10/website)
[](https://opencollective.com/feathers/sponsor/11/website)
[](https://opencollective.com/feathers/sponsor/12/website)
[](https://opencollective.com/feathers/sponsor/13/website)
[](https://opencollective.com/feathers/sponsor/14/website)
[](https://opencollective.com/feathers/sponsor/15/website)
[](https://opencollective.com/feathers/sponsor/16/website)
[](https://opencollective.com/feathers/sponsor/17/website)
[](https://opencollective.com/feathers/sponsor/18/website)
[](https://opencollective.com/feathers/sponsor/19/website)
[](https://opencollective.com/feathers/sponsor/20/website)
[](https://opencollective.com/feathers/sponsor/21/website)
[](https://opencollective.com/feathers/sponsor/22/website)
[](https://opencollective.com/feathers/sponsor/23/website)
[](https://opencollective.com/feathers/sponsor/24/website)
[](https://opencollective.com/feathers/sponsor/25/website)
[](https://opencollective.com/feathers/sponsor/26/website)
[](https://opencollective.com/feathers/sponsor/27/website)
[](https://opencollective.com/feathers/sponsor/28/website)
[](https://opencollective.com/feathers/sponsor/29/website)
### Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/feathers#backer)]
[](https://opencollective.com/feathers/backer/0/website)
[](https://opencollective.com/feathers/backer/1/website)
[](https://opencollective.com/feathers/backer/2/website)
[](https://opencollective.com/feathers/backer/3/website)
[](https://opencollective.com/feathers/backer/4/website)
[](https://opencollective.com/feathers/backer/5/website)
[](https://opencollective.com/feathers/backer/6/website)
[](https://opencollective.com/feathers/backer/7/website)
[](https://opencollective.com/feathers/backer/8/website)
[](https://opencollective.com/feathers/backer/9/website)
[](https://opencollective.com/feathers/backer/10/website)
[](https://opencollective.com/feathers/backer/11/website)
[](https://opencollective.com/feathers/backer/12/website)
[](https://opencollective.com/feathers/backer/13/website)
[](https://opencollective.com/feathers/backer/14/website)
[](https://opencollective.com/feathers/backer/15/website)
[](https://opencollective.com/feathers/backer/16/website)
[](https://opencollective.com/feathers/backer/17/website)
[](https://opencollective.com/feathers/backer/18/website)
[](https://opencollective.com/feathers/backer/19/website)
[](https://opencollective.com/feathers/backer/20/website)
[](https://opencollective.com/feathers/backer/21/website)
[](https://opencollective.com/feathers/backer/22/website)
[](https://opencollective.com/feathers/backer/23/website)
[](https://opencollective.com/feathers/backer/24/website)
[](https://opencollective.com/feathers/backer/25/website)
[](https://opencollective.com/feathers/backer/26/website)
[](https://opencollective.com/feathers/backer/27/website)
[](https://opencollective.com/feathers/backer/28/website)
[](https://opencollective.com/feathers/backer/29/website)
## Documentation
The [Feathers docs](http://docs.feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers.
## License
Copyright (c) 2019 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
Licensed under the [MIT license](LICENSE).
---
## File: readme.md
## A framework for real-time applications and REST APIs with JavaScript and TypeScript
[](https://github.com/feathersjs/feathers/actions?query=workflow%3A%22Node.js+CI%22)
[](https://codeclimate.com/github/feathersjs/feathers/maintainability)
[](https://codeclimate.com/github/feathersjs/feathers/test_coverage)
[](https://www.npmjs.com/package/@feathersjs/feathers)
[](http://slack.feathersjs.com)
[](https://t.me/featherjs)
Feathers is a lightweight web-framework for creating real-time applications and REST APIs using JavaScript or TypeScript.
Feathers can interact with any backend technology, supports over a dozen databases and works with any frontend technology like React, VueJS, Angular, React Native, Android or iOS.
## Getting started
You can build your first real-time and REST API in just 4 commands:
```bash
$ npm install @feathersjs/cli
$ mkdir my-new-app
$ cd my-new-app/
$ feathers generate app
$ npm start
```
To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](http://docs.feathersjs.com/guides).
## Support
### Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/feathers#sponsor)]
[](https://opencollective.com/feathers/sponsor/0/website)
[](https://opencollective.com/feathers/sponsor/1/website)
[](https://opencollective.com/feathers/sponsor/2/website)
[](https://opencollective.com/feathers/sponsor/3/website)
[](https://opencollective.com/feathers/sponsor/4/website)
[](https://opencollective.com/feathers/sponsor/5/website)
[](https://opencollective.com/feathers/sponsor/6/website)
[](https://opencollective.com/feathers/sponsor/7/website)
[](https://opencollective.com/feathers/sponsor/8/website)
[](https://opencollective.com/feathers/sponsor/9/website)
[](https://opencollective.com/feathers/sponsor/10/website)
[](https://opencollective.com/feathers/sponsor/11/website)
[](https://opencollective.com/feathers/sponsor/12/website)
[](https://opencollective.com/feathers/sponsor/13/website)
[](https://opencollective.com/feathers/sponsor/14/website)
[](https://opencollective.com/feathers/sponsor/15/website)
[](https://opencollective.com/feathers/sponsor/16/website)
[](https://opencollective.com/feathers/sponsor/17/website)
[](https://opencollective.com/feathers/sponsor/18/website)
[](https://opencollective.com/feathers/sponsor/19/website)
[](https://opencollective.com/feathers/sponsor/20/website)
[](https://opencollective.com/feathers/sponsor/21/website)
[](https://opencollective.com/feathers/sponsor/22/website)
[](https://opencollective.com/feathers/sponsor/23/website)
[](https://opencollective.com/feathers/sponsor/24/website)
[](https://opencollective.com/feathers/sponsor/25/website)
[](https://opencollective.com/feathers/sponsor/26/website)
[](https://opencollective.com/feathers/sponsor/27/website)
[](https://opencollective.com/feathers/sponsor/28/website)
[](https://opencollective.com/feathers/sponsor/29/website)
### Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/feathers#backer)]
[](https://opencollective.com/feathers/backer/0/website)
[](https://opencollective.com/feathers/backer/1/website)
[](https://opencollective.com/feathers/backer/2/website)
[](https://opencollective.com/feathers/backer/3/website)
[](https://opencollective.com/feathers/backer/4/website)
[](https://opencollective.com/feathers/backer/5/website)
[](https://opencollective.com/feathers/backer/6/website)
[](https://opencollective.com/feathers/backer/7/website)
[](https://opencollective.com/feathers/backer/8/website)
[](https://opencollective.com/feathers/backer/9/website)
[](https://opencollective.com/feathers/backer/10/website)
[](https://opencollective.com/feathers/backer/11/website)
[](https://opencollective.com/feathers/backer/12/website)
[](https://opencollective.com/feathers/backer/13/website)
[](https://opencollective.com/feathers/backer/14/website)
[](https://opencollective.com/feathers/backer/15/website)
[](https://opencollective.com/feathers/backer/16/website)
[](https://opencollective.com/feathers/backer/17/website)
[](https://opencollective.com/feathers/backer/18/website)
[](https://opencollective.com/feathers/backer/19/website)
[](https://opencollective.com/feathers/backer/20/website)
[](https://opencollective.com/feathers/backer/21/website)
[](https://opencollective.com/feathers/backer/22/website)
[](https://opencollective.com/feathers/backer/23/website)
[](https://opencollective.com/feathers/backer/24/website)
[](https://opencollective.com/feathers/backer/25/website)
[](https://opencollective.com/feathers/backer/26/website)
[](https://opencollective.com/feathers/backer/27/website)
[](https://opencollective.com/feathers/backer/28/website)
[](https://opencollective.com/feathers/backer/29/website)
## Documentation
The [Feathers docs](http://docs.feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers.
## License
Copyright (c) 2019 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
Licensed under the [MIT license](LICENSE).
---
## File: docs/index.md
---
layout: page
sidebar: false
title: Feathers
titleTemplate: The API and Real-time Application Framework
---