Get started tutorial

How to create new Data-Models

Installation and setup

1. Open ScienceDbBackend project/folder and run following (Note: examples represent how to create taxon Data-Model which has 3 attributes: name, taxonomic_level, parent_id):

./node_modules/.bin/sequelize model:create --name taxon --attributes 'name:string, taxonomic_level:string, parent_id:integer'
cd /server/models

Currently the model have to be modified manually (see examples bellow).

• automatically generated model:

'use strict';
module.exports = function(sequelize, DataTypes) {
  var taxon = sequelize.define('taxon', {
    name: DataTypes.STRING,
    taxonomic_level: DataTypes.STRING,
    parent_id: DataTypes.INTEGER
  }, {
    classMethods: {
      associate: function(models) {
        // associations can be defined here
      }
    }
  });
  return taxon;
};

• and modified model (Note: you can edit it on your host or into docker container using vim ):

'use strict';
module.exports = function(sequelize, DataTypes) {
  var taxon = sequelize.define('taxon', {
    id: {
      type: DataTypes.INTEGER,
      autoIncrement: true,
      primaryKey: true,
      allowNull: false
    },
    name: {
      type: DataTypes.STRING,
      allowNull: false
    },
    taxonomic_level: {
      type: DataTypes.STRING,
      allowNull: false
    },
    parent_id: DataTypes.INTEGER
  }, {
    classMethods: {
      associate: function(models) {
        taxon.belongsTo(models.taxon, {foreignKey: 'parent_id', targetKey: 'id'})
      }
    }
  });
  return taxon;
};

2. Run the migration to create the tables:

./node_modules/.bin/sequelize db:migrate

3. Create routes/controller:

express_route_gen . --name taxon --attributes 'name:string, taxonomic_level:string, parent_id:integer'

4. Generate GUI. Run command in admin_gui_gen:

admin_gui_gen . --baseUrl http://localhost:3000 --name taxon --attributes 'name:string, taxonomic_level:string' --belongsTo 'taxon:parent_id:id:name:taxonomic_level'

5. Edit index.js file (which is located in ScienceDbGui/router folder)

• add following objects into routes array:

    {
      path: '/taxons',
      name: 'taxons',
      component: taxons,
    },
    {
      path: '/taxon/:id',
      name: 'taxonEdit',
      component: taxonEdit,
    },
    {
      path: '/taxon',
      name: 'taxonCreate',
      component: taxonCreate,
    }

Note: don't forget to import appropriate components

import taxons from '@/components/taxons'
import taxonCreate from '@/components/taxonCreateForm'
import taxonEdit from '@/components/taxonEditForm'

6. Prepoulate taxons with some data:

curl 'http://localhost:3000/taxons' -X POST --data 'name=test_1&taxonomic_level=level_1'