Awesome Open Source
Awesome Open Source


All Contributors

Feathers data provider for react-admin

The perfect match to build Backend and Frontend Admin, based on REST services. For using Feathers with react-admin.

If you are searching for admin-on-rest (older react-admin version), please use 1.0.0 version

Supported react-admin request types

ra-data-feathers currently supports the following request types. More information on react-admin request types is available for data providers and auth providers in the react-admin documentation.

  • Data Provider
    • GET_LIST
    • GET_ONE
    • CREATE
    • UPDATE
    • DELETE
    • GET_MANY
  • Auth Provider


In your react-admin app just add ra-data-feathers dependency:

npm install ra-data-feathers --save


Feathers Client

Both restClient and authClient depend on a configured Feathers client instance.

Configuration of the Feathers client is beyond the scope of this document. See the Feathers documentation for more information on configuring the Feathers client. Both of the following need to be configured in the Feathers client for use with ra-data-feathers.

Data Provider (restClient)

The ra-data-feathers data provider (restClient) accepts two arguments: client and options.

clientshould be a configured Feathers client instance. This argument is required.

options contains configurable options for the ra-data-feathers restClient. The options argument is optional and can be omitted. In this case, defaults will be used.

const options = {
  id: 'id', // If your database uses an id field other than 'id'. Optional.
  usePatch: false, // Use PATCH instead of PUT for UPDATE requests. Optional.
  my_resource: { // Options for individual resources can be set by adding an object with the same name. Optional.
    id: 'id', // If this specific table uses an id field other than 'id'. Optional.
  /* Allows to use custom query operators from various feathers-database-adapters in GET_MANY calls.
   * Will be merged with the default query operators ['$gt', '$gte', '$lt', '$lte', '$ne', '$sort', '$or', '$nin', '$in']
  customQueryOperators: []

Performant Bulk Actions can be used by enabling multi options in the feathers application

Auth Provider (authClient)

authClient also accepts two parameters. client and options.

clientshould be a configured Feathers client instance. This argument is required.

options contains configurable options for the ra-data-feathers authClient. The options argument is optional and can be omitted. In this case, defaults shown below will be used.

const options = {
  storageKey: 'token', // The key in localStorage used to store the authentication token
  authenticate: { // Options included in calls to Feathers client.authenticate
    strategy: 'local', // The authentication strategy Feathers should use
  permissionsKey: 'permissions', // The key in localStorage used to store permissions from decoded JWT
  permissionsField: 'roles', // The key in the decoded JWT containing the user's role
  passwordField: 'password', // The key used to provide the password to Feathers client.authenticate
  usernameField: 'email', // The key used to provide the username to Feathers client.authenticate
  redirectTo: '/login', // Redirect to this path if an AUTH_CHECK fails. Uses the react-admin default of '/login' if omitted.
  logoutOnForbidden: true, // Logout when response status code is 403

Usage with the react-admin <Admin> component

ra-data-feathers can be used by passing the restClient and authClient to the react-admin <Admin> component as the dataProvider and authProvider params respectively:

  dataProvider={restClient(feathersClient, restClientConfig)}
  authProvider={authClient(feathersClient, authClientConfig)}


This example assumes the following:

  • A configured Feathers client is available at ./feathersClient
  • The Feathers authentication service includes a field called userroles
  • List components for AResource and AnotherResource are available in ./resources
import { Admin, Resource } from 'react-admin';
import feathersClient from './feathersClient';
import { AResourceList } from './resources/AResource/List';
import { AnotherResourceList } from './resources/AnotherResourceList';
import { restClient, authClient } from 'ra-data-feathers';

const restClientOptions = {
  id: '_id', // In this example, the database uses '_id' rather than 'id'
  usePatch: true // Use PATCH instead of PUT for updates

const authClientOptions = {
  usernameField: 'username', // Our example database might use 'username' rather than 'email'
  permissionsField: 'userroles', // Use the 'userroles' field on the JWT as the users role
  redirectTo: '/signin', // Our example login form might be at '/signin', redirect here if AUTH_CHECK fails

const App = () => (
    title='ra-data-feathers Example'
    dataProvider={restClient(feathersClient, restClientOptions)}
    authProvider={authClient(feathersClient, authClientOptions)}
    {permissions => [
      permissions === 'admin' ? // Only show this resource if the user role is 'admin'
        /> : null;

Note: the permissions restriction above only affects whether a given resource is visible or not, and will not prevent users from accessing your API directly. In most projects, this option would be used with user/role restriction hooks on the server side such as feathers-authentication-hooks.

You can find a complete example in

Running tests

Tests for the ra-data-feathers module are available from the root directory of the module with:

npm run test


This software is licensed under the MIT Licence, and sponsored by CambΓ‘.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

JosΓ© Luis Di Biase

πŸ’» πŸ“–

Nicholas Nelson

πŸ’» πŸ“–


πŸ’» πŸ“–

Amr Noman

πŸ’» πŸ“–

Lijo Antony

πŸ’» πŸ“–

tony kerz

πŸ’» πŸ“–

Dmitrii Maganov

πŸ’» πŸ“–


πŸ’» πŸ“–

WΓ©dney Yuri

πŸ’» πŸ“–

Igor Berlenko

πŸ’» πŸ“–

Tomasz Bak

πŸ’» πŸ“–

Dan Stevens

πŸ’» πŸ“–

Daniel Prentis

πŸ’» πŸ“–

Facundo Mainere

πŸ’» πŸ“–

Fernando Navarro

πŸ’» πŸ“–


πŸ’» πŸ“–

Mohammed Faizuddin

πŸ’» πŸ“–

Ryan Harmuth

πŸ’» πŸ“–

Santiago Botta

πŸ’» πŸ“–

Taylor Goodall

πŸ’» πŸ“–

Alexander Friedl

πŸ’» πŸ“–

FΓ‘bio Toi

πŸ’» πŸ“–


πŸ’» πŸ“–


πŸ’» πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (68,028)Β 
react (5,153)Β 
rest (477)Β 
admin-dashboard (175)Β 
react-admin (26)Β 
feathersjs (14)Β 

Find Open Source By Browsing 7,000 Topics Across 59 Categories

Advertising πŸ“¦Β 10
All Projects
Application Programming Interfaces πŸ“¦Β 124
Applications πŸ“¦Β 192
Artificial Intelligence πŸ“¦Β 78
Blockchain πŸ“¦Β 73
Build Tools πŸ“¦Β 113
Cloud Computing πŸ“¦Β 80
Code Quality πŸ“¦Β 28
Collaboration πŸ“¦Β 32
Command Line Interface πŸ“¦Β 49
Community πŸ“¦Β 83
Companies πŸ“¦Β 60
Compilers πŸ“¦Β 63
Computer Science πŸ“¦Β 80
Configuration Management πŸ“¦Β 42
Content Management πŸ“¦Β 175
Control Flow πŸ“¦Β 213
Data Formats πŸ“¦Β 78
Data Processing πŸ“¦Β 276
Data Storage πŸ“¦Β 135
Economics πŸ“¦Β 64
Frameworks πŸ“¦Β 215
Games πŸ“¦Β 129
Graphics πŸ“¦Β 110
Hardware πŸ“¦Β 152
Integrated Development Environments πŸ“¦Β 49
Learning Resources πŸ“¦Β 166
Legal πŸ“¦Β 29
Libraries πŸ“¦Β 129
Lists Of Projects πŸ“¦Β 22
Machine Learning πŸ“¦Β 347
Mapping πŸ“¦Β 64
Marketing πŸ“¦Β 15
Mathematics πŸ“¦Β 55
Media πŸ“¦Β 239
Messaging πŸ“¦Β 98
Networking πŸ“¦Β 315
Operating Systems πŸ“¦Β 89
Operations πŸ“¦Β 121
Package Managers πŸ“¦Β 55
Programming Languages πŸ“¦Β 245
Runtime Environments πŸ“¦Β 100
Science πŸ“¦Β 42
Security πŸ“¦Β 396
Social Media πŸ“¦Β 27
Software Architecture πŸ“¦Β 72
Software Development πŸ“¦Β 72
Software Performance πŸ“¦Β 58
Software Quality πŸ“¦Β 133
Text Editors πŸ“¦Β 49
Text Processing πŸ“¦Β 136
User Interface πŸ“¦Β 330
User Interface Components πŸ“¦Β 514
Version Control πŸ“¦Β 30
Virtualization πŸ“¦Β 71
Web Browsers πŸ“¦Β 42
Web Servers πŸ“¦Β 26
Web User Interface πŸ“¦Β 210