KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

ra-data-django-rest-framework

★ 108 Open GitHub ↗

react-admin data provider for Django REST framework

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ra-data-django-rest-framework

[react-admin](https://marmelab.com/react-admin/) data and authentication provider for [Django REST
framework](https://www.django-rest-framework.org/).

[![Stable Release](https://img.shields.io/npm/v/ra-data-django-rest-framework)](https://npm.im/ra-data-django-rest-framework)
[![license](https://badgen.now.sh/badge/license/MIT)](https://raw.githubusercontent.com/bmihelac/ra-data-django-rest-framework/master/LICENSE)
![CI](https://github.com/bmihelac/ra-data-django-rest-framework/workflows/CI/badge.svg)
[![codecov](https://codecov.io/gh/bmihelac/ra-data-django-rest-framework/branch/master/graph/badge.svg)](https://codecov.io/gh/bmihelac/ra-data-django-rest-framework)

ra-data-django-rest-framework includes backend and client example application
and tests.

## Install

```bash
npm install ra-data-django-rest-framework
```

## Usage

```javascript
import drfProvider from 'ra-data-django-rest-framework';
const dataProvider = drfProvider("/api");
```

## Features

* Sorting
* Pagination
* Filtering
* Authentication

### Sorting

Ordering for
[OrderingFilter](https://www.django-rest-framework.org/api-guide/filtering/#orderingfilter)
is supported.

### Pagination

Currently pagination with
[PageNumberPagination](https://www.django-rest-framework.org/api-guide/pagination/#pagenumberpagination)
is supported.

Default `PageNumberPagination` has `page_size_query_param` set to `None`,
overide to be able to set *Rows per page*, ie:

```python
from rest_framework.pagination import PageNumberPagination

class PageNumberWithPageSizePagination(PageNumberPagination):
    page_size_query_param = 'page_size'
```

### Filtering

ra-data-django-rest-framework supports:

* [Generic Filtering](https://www.django-rest-framework.org/api-guide/filtering/#generic-filtering)
* [DjangoFilterBackend](https://www.django-rest-framework.org/api-guide/filtering/#djangofilterbackend)

### Authentication

#### tokenAuthProvider

`tokenAuthProvider` uses
[TokenAuthentication](https://www.django-rest-framework.org/api-guide/authentication/#tokenauthentication)
to obtain token from django-rest-framework. User token is saved in `localStorage`.

`tokenAuthProvider` accepts options as second argument with
`obtainAuthTokenUrl` key. Default URL for obtaining a token is `/api-token-auth/`.

`fetchJsonWithAuthToken` overrides *httpClient* and adds authorization header
with previously saved user token to every request.

```javascrtipt
import drfProvider, { tokenAuthProvider, fetchJsonWithAuthToken } from 'ra-data-django-rest-framework';

const authProvider = tokenAuthProvider()
const dataProvider = drfProvider("/api", fetchJsonWithAuthToken);
```

#### jwtTokenAuthProvider

`jwtTokenAuthProvider` uses
[JSON Web Token Authentication](https://www.django-rest-framework.org/api-guide/authentication/#json-web-token-authentication)
to obtain token from django-rest-framework. User token is saved in `localStorage`.

`jwtTokenAuthProvider` accepts options as second argument with
`obtainAuthJWTTokenUrl` key. Default URL for obtaining a token is `/api/token/`.

`fetchJsonWithAuthJWTToken` overrides *httpClient* and adds authorization header
with previously saved user token to every request.

```javascrtipt
import drfProvider, { jwtTokenAuthProvider, fetchJsonWithAuthJWTToken } from 'ra-data-django-rest-framework';

const authProvider = jwtTokenAuthProvider()
const dataProvider = drfProvider("/api", fetchJsonWithAuthJWTToken);
```

## Example app

### Django application with django-rest-framework

Setup virtual envirnoment, install requirements and load initial data:

```bash
cd example/backend
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt
./manage.py migrate
./manage.py loaddata initial
```

Run server:

```bash
./manage.py runserver
```

Admin credentials in the example app are:

`admin`
`password`

### React-admin demo application

```bash
yarn install # install ra-data-django-rest-framework
cd example/client
yarn install
yarn start
```

You can now view example app in the browser: http://localhost:3000
Login with user `admin`, password is `password` or create new users in Django
admin dashboard or shell.

By default the ``rest_framework.authentication.TokenAuthentication`` will be 
used. To use ``rest_framework_simplejwt.authentication.JWTAuthentication``, set
the value of the ``REACT_APP_USE_JWT_AUTH`` variable in the .env 
file (example/client/.env) to true, as shown below:

```text
REACT_APP_USE_JWT_AUTH=true
```

## Contributing

This project was bootstrapped with [TSDX](https://github.com/jaredpalmer/tsdx).
All features that TSDX provides should work here too.

```bash
yarn start
```

```bash
yarn test
```

## TODO

* examples for image upload

ra-data-django-rest-framework

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README