admin-on-rest-models

Role | Name | Email | Slack ---- | ---- | ----- | ----- Product Owner | Ryan Borker | [email protected] | [@borker] Maintainer | Mark Miyashita | [email protected] | [@mark]

Overview

Generates "Resource" pages (React components) for the admin-on-rest Admin Panel to consume. Each model has a separate component in the admin panel with a table of all resources.

Templates

This module is compatible with the following templates:

• admin-on-rest

Usage

To use, add the following to your gig.yaml under the admin-on-rest block:

- name: admin-on-rest-models
  location: >-
    https://github.com/liquidlabs-co/gig-modules/tree/master/block/admin-on-rest-models
  spec: {}

After adding this config, your block should look something like:

- name: admin-web
  type: web
  spec:
    template:
      name: admin-on-rest
      type: gigster
      location: >-
        https://github.com/liquidlabs-co/gig-templates/tree/master/block/admin-on-rest
      spec:
        name: admin-on-rest
        api: loopback
    modules:
      - name: admin-on-rest-models
        location: >-
          https://github.com/liquidlabs-co/gig-modules/tree/master/block/admin-on-rest-models
        spec: {}

Features

Currently, this module only generates the "Resource" pages for each Model. It also adds a link for each model to the Menu.

TODO

• Render data from the database using the Loopback API.
• Authenticate with a real API.
• Generate the correct columns based off the model definition.
• Access and use CRUD endpoints from the Loopback API.

Tests

Module tests are defined using a test/scenarios.yaml file. This file defines the set of example gigs that we generate as part of integration testing. To run all tests, run yarn test at the root of this module.

Each scenario is generated in test/scenario/<name> which you can then cd into and run the actual app. For a scenario called default, this is done via:

cd test/scenario/default
yarn install

# Run tests.
yarn test

# Start the app.
yarn start