mirror of
https://github.com/feathersjs/feathers.git
synced 2026-01-25 15:23:13 +00:00
38 lines
1.9 KiB
Markdown
38 lines
1.9 KiB
Markdown
# Feathers - The API and Real-time Application Framework
|
|
|
|
[](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
|
|
[](https://codeclimate.com/github/feathersjs/feathers/maintainability)
|
|
[](https://codeclimate.com/github/feathersjs/feathers/test_coverage)
|
|
[](https://www.npmjs.com/package/@feathersjs/feathers)
|
|
[](https://discord.gg/qa8kez8QBx)
|
|
|
|
Feathers is a lightweight web-framework for creating APIs and real-time applications with TypeScript or JavaScript.
|
|
|
|
<a href="https://feathersjs.com" title="FeathersJS">
|
|
<img src="https://user-images.githubusercontent.com/128857/173851241-b52de3b8-468d-4ac3-a4b3-eaae9c8b7f77.jpg" alt="The FeathersJS Family of Birds">
|
|
</a>
|
|
|
|
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://dove.feathersjs.com/guides/).
|
|
|
|
## Documentation
|
|
|
|
The [Feathers website](http://feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers.
|
|
|
|
## License
|
|
|
|
Copyright (c) 2022 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
|
|
|
|
Licensed under the [MIT license](LICENSE).
|