@gigster/module-express-models

Role | Name | Email | Slack ---- | ---- | ----- | ----- *Product Owner* | Ryan Borker | [borker@gigster.com](mailto:boker@gigster.com) | [@borker] *Maintainer* | Mark Miyashita | [mark.miyashita@gigster.com](mailto:mark.miyashita@gigster.com) | [@mark]

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@gigster/module-express-models
Minified + gzip package size for @gigster/module-express-models in KB

Readme

express-models

Role Name Email Slack
Product Owner Ryan Borker borker@gigster.com [@borker]
Maintainer Mark Miyashita mark.miyashita@gigster.com [@mark]

Overview

Generates a Model and Controller for each model defined in the project definition.

Templates

This module is compatible with the following templates:

Usage

To use, add the following to your gig.yaml under the generator-express block:

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

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

- name: api
  type: api
  spec:
    template:
      name: express
      type: yeoman
      location: 'github:petecoop/generator-express'
      spec:
        createDirectory: false
        type: MVC
        viewEngine: EJS
        cssPreprocessor: None
        database: None
        buildTool: Gulp
    modules:
      - name: express-models
        location: >-
          https://github.com/liquidlabs-co/gig-modules/tree/master/block/express-models
        spec: {}

Features

Currently, this module only generates a blank Model and custom routes for the Controller.

TODO

  • CRUD routes for all models.

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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.