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.

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.0.34 (2025-05-03)

Bug Fixes

• Update dependencies (#3584) (119fa4e)

5.0.33 (2025-02-24)

Bug Fixes

• dependencies: Update dependencies (#3571) (ad611cb)

5.0.32 (2025-02-01)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.31 (2024-10-31)

Bug Fixes

• dependencies: Update all dependencies (#3545) (221b92b)

5.0.30 (2024-09-02)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.29 (2024-07-10)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.28 (2024-07-10)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.27 (2024-06-18)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.26 (2024-06-09)

Bug Fixes

• adapter-commons: Faster sorter (#3495) (22243e4)

5.0.25 (2024-05-03)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.24 (2024-03-13)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.23 (2024-02-25)

Bug Fixes

• core: Update to latest feathersjs/hooks (#3434) (1499ccc)

5.0.22 (2024-02-15)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.21 (2024-01-25)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.20 (2024-01-24)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.19 (2024-01-23)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.18 (2024-01-22)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.17 (2024-01-22)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.16 (2024-01-22)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.15 (2024-01-22)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.14 (2024-01-05)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.13 (2023-12-29)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.12 (2023-11-28)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.11 (2023-10-11)

Bug Fixes

• knex: Update all dependencies and Knex peer (#3308) (d2f9860)

5.0.10 (2023-10-03)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.9 (2023-09-27)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.8 (2023-07-19)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.7 (2023-07-14)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.6 (2023-06-15)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.5 (2023-04-28)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.4 (2023-04-12)

Bug Fixes

• Make sure all Readme files are up to date (#3154) (a5f0b38)

5.0.3 (2023-04-05)

Bug Fixes

• dependencies: Update all dependencies (#3139) (f24276e)

5.0.1 (2023-03-15)

Bug Fixes

• core: Add PaginationParams to general find method (#3095) (8ebdcf5)
• core: Use Symbol.for to instantiate shared symbols (#3087) (7f3fc21)

5.0.0 (2023-02-24)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.38 (2023-02-17)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.37 (2023-02-09)

Features

• mongodb: Add Object ID keyword converter and update MongoDB CLI & docs (#3041) (ca0994e)

5.0.0-pre.36 (2023-01-29)

Bug Fixes

• databases: Ensure that query sanitization is not necessary when using query schemas (#3022) (dbf514e)

Features

• database: Add and to the query syntax (#3021) (00cb0d9)

5.0.0-pre.35 (2023-01-12)

Features

• generators: Move core code generators to shared generators package (#2982) (0328d22)

5.0.0-pre.34 (2022-12-14)

Bug Fixes

• adapter-commons: multiple type definition issues (#2876) (4ff1ed0)

Features

• adapter: Add patch data type to adapters and refactor AdapterBase usage (#2906) (9ddc2e6)

5.0.0-pre.33 (2022-11-08)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.32 (2022-10-26)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.31 (2022-10-12)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.30 (2022-10-07)

Features

• core: Allow to unregister services at runtime (#2756) (d16601f)

5.0.0-pre.29 (2022-09-16)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.28 (2022-08-03)

Bug Fixes

• cli: Improve generated application and client (#2701) (bd55ffb)

5.0.0-pre.27 (2022-07-13)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.26 (2022-06-22)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.25 (2022-06-22)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.24 (2022-06-21)

Features

• knex: Add KnexJS SQL database adapter to core (#2671) (9380fff)

5.0.0-pre.23 (2022-06-06)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.22 (2022-05-24)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.21 (2022-05-23)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.20 (2022-05-04)

Bug Fixes

• dependencies: Lock monorepo package version numbers (#2623) (5640c10)

5.0.0-pre.19 (2022-05-01)

Bug Fixes

• adapter-commons: Clarify adapter query filtering (#2607) (2dac771)

Features

• mongodb: Add feathers-mongodb adapter as @feathersjs/mongodb (#2610) (6d43734)
• typescript: Improve adapter typings (#2605) (3b2ca0a)
• typescript: Improve params and query typeability (#2600) (df28b76)

BREAKING CHANGES

• adapter-commons: Changes the common adapter base class to use sanitizeQuery and sanitizeData

5.0.0-pre.18 (2022-04-11)

Features

• core: Add app.teardown functionality (#2570) (fcdf524)
• core: Finalize app.teardown() functionality (#2584) (1a166f3)

5.0.0-pre.17 (2022-02-15)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.16 (2022-01-12)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.15 (2021-11-27)

Bug Fixes

• adapter-commons: clean up in sort.ts and select function (#2492) (c3ec8a4)
• adapter-commons: Fix sorting for embedded objects (#2488) (9c22f70)
• typescript: Overall typing improvements (#2478) (b8eb804)

5.0.0-pre.14 (2021-10-13)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.13 (2021-10-13)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.12 (2021-10-12)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.11 (2021-10-06)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.10 (2021-09-19)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.9 (2021-08-09)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.8 (2021-08-09)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.7 (2021-08-09)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.6 (2021-08-08)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-pre.5 (2021-06-23)

Bug Fixes

• Update database adapter common repository urls (#2380) (3f4db68)

Features

• adapter-commons: Add support for params.adapter option and move memory adapter to @feathersjs/memory (#2367) (a43e7da)
• typescript: Allow to pass generic service options to adapter services (#2392) (f9431f2)

5.0.0-pre.4 (2021-05-13)

Bug Fixes

• typescript: Move Paginated type back for better compatibility (#2350) (2917d05)

5.0.0-pre.3 (2021-04-21)

Bug Fixes

• typescript: Improve TypeScript backwards compatibility (#2310) (f33be73)

5.0.0-pre.2 (2021-04-06)

Note: Version bump only for package @feathersjs/adapter-commons

5.0.0-beta.1 (2021-04-03)

Bug Fixes

• dependencies: Fix transport-commons dependency and update other dependencies (#2284) (05b03b2)

Features

• adapter-commons: Added mongoDB like search in embedded objects (687e3c7)

5.0.0-beta.0 (2021-03-28)

Bug Fixes

• adapter-commons: Always respect paginate.max (#2267) (f588257)
• Update Grant usage and other dependencies (#2264) (7b0f8fa)
• adapter-commons: Return missing overloads (#2203) (bbe7e2a)

Features

• Feathers v5 core refactoring and features (#2255) (2dafb7c)

5.0.0-pre.1 (2020-12-17)

Features

• memory: Move feathers-memory into @feathersjs/memory (#2153) (dd61fe3)

4.5.11 (2020-12-05)

Note: Version bump only for package @feathersjs/adapter-commons

4.5.7 (2020-10-21)

Bug Fixes

• typescript: Remove remaining overloads (a29fabc)

4.5.6 (2020-10-21)

Bug Fixes

• Revert "fix(adapter-commons): Add missing overloads (#4)" (dfaa850)

4.5.5 (2020-10-21)

Bug Fixes

• typescript: Revert "fix: add overloads for find (#9)" (85c20b2)

4.5.4 (2020-09-27)

Note: Version bump only for package @feathersjs/adapter-commons

4.5.3 (2020-09-24)

Bug Fixes

• add overloads for find (#9) (87c7c29)
• adapter-commons: Add missing overloads (#4) (b6c80ff)
• Improve Service typings for DB Common API (#1) (fd3b949)

4.5.2 (2020-03-04)

Note: Version bump only for package @feathersjs/adapter-commons

4.5.1 (2020-01-24)

Note: Version bump only for package @feathersjs/adapter-commons

4.5.0 (2020-01-18)

Note: Version bump only for package @feathersjs/adapter-commons

4.4.3 (2019-12-06)

Bug Fixes

• adapter-commons: Filter arrays in queries (#1724) (872b669)

4.4.1 (2019-11-27)

Note: Version bump only for package @feathersjs/adapter-commons

4.4.0 (2019-11-27)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.11 (2019-11-11)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.10 (2019-10-26)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.9 (2019-10-26)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.8 (2019-10-14)

Bug Fixes

• Remove adapter commons type alternatives (#1620) (c9f3086)

4.3.7 (2019-10-14)

Bug Fixes

• improve Service and AdapterService types (#1567) (baad6a2)

4.3.6 (2019-10-07)

Bug Fixes

• Check query for NaN (#1607) (f1a781f)

4.3.4 (2019-10-03)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.3 (2019-09-21)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.2 (2019-09-16)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.1 (2019-09-09)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.0 (2019-08-27)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.0-pre.4 (2019-08-22)

Note: Version bump only for package @feathersjs/adapter-commons

4.3.0-pre.3 (2019-08-19)

Bug Fixes

• Update all dependencies (7d53a00)

4.3.0-pre.2 (2019-08-02)

Bug Fixes

• @feathersjs/adapter-commons: update id is non-nullable (#1468) (43ec802)

4.3.0-pre.1 (2019-07-11)

Note: Version bump only for package @feathersjs/adapter-commons

4.0.0-pre.5 (2019-07-10)

Note: Version bump only for package @feathersjs/adapter-commons

4.0.0-pre.4 (2019-07-05)

Bug Fixes

• @feathersjs/adapter-commons: remove data from remove arguments (#1426) (fd54ae9)

Features

• adapter-commons: add allowsMulti(method) to AdapterService (#1431) (e688851)
• Add hook-less methods and service option types to adapter-commons (#1433) (857f54a)

4.0.0-pre.3 (2019-06-01)

Bug Fixes

• Update dependencies and fix tests (#1373) (d743a7f)

4.0.0-pre.2 (2019-05-15)

Note: Version bump only for package @feathersjs/adapter-commons

4.0.0-pre.1 (2019-05-08)

Note: Version bump only for package @feathersjs/adapter-commons

4.0.0-pre.0 (2019-04-21)

Bug Fixes

• Update all dependencies to latest (#1206) (e51e0f6)
• adapter-commons: Keep Symbols when filtering a query (#1141) (c9f55d8)
• chore: Add .npmignore to adapter-commons (8e129d8)
• Add whitelist and filter support to common adapter service (#1132) (df1daaa)
• Fix AdapterService multi option when set to true (#1134) (40402fc)
• Throw error in filterQuery when query parameter is unknown (#1131) (cd1a183)
• Update adapter common tests (#1135) (8166dda)
• Update adapter common tests to check for falsy (#1140) (2856722)

chore

• package: Move adapter tests into their own module (#1164) (dcc1e6b)

Features

• Add TypeScript definitions (#1275) (9dd6713)
• Authentication v3 core server implementation (#1205) (1bd7591)
• Common database adapter utilities and test suite (#1130) (17b3dc8)

BREAKING CHANGES

• package: Removes adapter tests from @feathersjs/adapter-commons
• Move database adapter utilities from @feathersjs/commons into its own module

2.0.0 (2019-01-10)

chore

• package: Move adapter tests into their own module (#1164) (dcc1e6b)

BREAKING CHANGES

• package: Removes adapter tests from @feathersjs/adapter-commons

1.0.7 (2019-01-02)

Bug Fixes

• chore: Add .npmignore to adapter-commons (8e129d8)

1.0.6 (2018-12-21)

Bug Fixes

• adapter-commons: Keep Symbols when filtering a query (#1141) (c9f55d8)

1.0.5 (2018-12-20)

Bug Fixes

• Update adapter common tests to check for falsy (#1140) (2856722)

1.0.4 (2018-12-17)

Bug Fixes

• Update adapter common tests (#1135) (8166dda)

1.0.3 (2018-12-17)

Bug Fixes

• Fix AdapterService multi option when set to true (#1134) (40402fc)

1.0.2 (2018-12-17)

Bug Fixes

• Add whitelist and filter support to common adapter service (#1132) (df1daaa)

1.0.1 (2018-12-17)

Bug Fixes

• Throw error in filterQuery when query parameter is unknown (#1131) (cd1a183)

1.0.0 (2018-12-16)

Features

• Common database adapter utilities and test suite (#1130) (17b3dc8)

BREAKING CHANGES

• Move database adapter utilities from @feathersjs/commons into its own module