https://github.com/kimkha/aor-loopback
Loopback-style REST Client for Admin-on-rest
https://github.com/kimkha/aor-loopback
admin-on-rest loopback restful-api
Last synced: about 2 months ago
JSON representation
Loopback-style REST Client for Admin-on-rest
- Host: GitHub
- URL: https://github.com/kimkha/aor-loopback
- Owner: kimkha
- License: mit
- Created: 2017-03-10T03:31:58.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-05T21:16:27.000Z (over 2 years ago)
- Last Synced: 2025-04-10T23:05:30.637Z (about 2 months ago)
- Topics: admin-on-rest, loopback, restful-api
- Language: JavaScript
- Size: 161 KB
- Stars: 44
- Watchers: 4
- Forks: 23
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Loopback-style REST Client for Admin-on-rest
Loopback-style REST Client for [admin-on-rest](https://github.com/marmelab/admin-on-rest), the frontend framework for building admin applications on top of REST services.
## Not maintained anymore
With new [react-admin](), please use [loopback-component-react-admin](https://github.com/kimkha/loopback-component-react-admin) instead.
Because of recent changes of **admin-on-rest**, this module will only support version 0.9.0 (or later) of admin-on-rest.
## Prerequisite
* Your loopback server must response `X-Total-Count` header when querying list. Please use [loopback3-xTotalCount](https://github.com/kimkha/loopback3-xTotalCount) on your server end.
## How to use
1. `yarn add aor-loopback`
2. On your `App.js`, add this:
```
import loopbackRestClient from 'aor-loopback';
...
```
3. If you want this module handle authentication, add this:
```
import loopbackRestClient, {authClient} from 'aor-loopback';
...
```
## Example
Please check example here: [loopback-aor-boilerplate](https://github.com/kimkha/loopback-aor-boilerplate), you should clone it and change your model later.
## License
This module is licensed under the [MIT Licence](LICENSE).