https://github.com/marmelab/admin-config
Configuration API to describe an administration interface. Used by ng-admin and react-admin.
https://github.com/marmelab/admin-config
angular ng-admin
Last synced: 1 day ago
JSON representation
Configuration API to describe an administration interface. Used by ng-admin and react-admin.
- Host: GitHub
- URL: https://github.com/marmelab/admin-config
- Owner: marmelab
- Archived: true
- Created: 2015-05-19T07:28:03.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-06-27T16:16:30.000Z (almost 8 years ago)
- Last Synced: 2026-05-03T21:31:48.200Z (about 2 months ago)
- Topics: angular, ng-admin
- Language: JavaScript
- Homepage:
- Size: 190 KB
- Stars: 31
- Watchers: 18
- Forks: 47
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-github-projects - admin-config - Configuration API to describe an administration interface. Used by ng-admin and react-admin. ⭐31 `JavaScript` (📦 Legacy & Inactive Projects)
README
# admin-config [](https://travis-ci.org/marmelab/admin-config)
Common files used in both [ng-admin](https://github.com/marmelab/ng-admin) and [ng-admin-react](https://github.com/marmelab/ng-admin-react).
## Installation
```sh
make install
```
## Including In Another Library
Require whatever class you need directly.
```js
// es5
var NumberField = require('admin-config/lib/Field/NumberField');
// es6
import NumberField from "admin-config/lib/Field/NumberField";
```
Admin-config is written in ES6. You'll need a transpiler to use any of the classes (we recommend [Webpack](http://webpack.github.io/) and [babel](https://babeljs.io/)). Here is an example Webpack configuration:
```js
module.exports = {
// ...
module: {
loaders: [
{ test: /node_modules\/admin-config\/.*\.js$/, loader: 'babel' }
]
}
};
```
## Transpiling
In order to increase this library compatibility and to not force other users of this
library to use Babel, you need to transpile your ES6 code from `src/` to good old ES5
code (in `lib/`).
Just run:
``` sh
make transpile
```
And you are done!
## Running Tests
```sh
make test
```