Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.25 KB

development-data.md

File metadata and controls

37 lines (24 loc) · 1.25 KB
Raw

Data in development

Setup

cp scripts/data.example.js scripts/data.js

Initializing data

We provide the init-data.js script to initialize Stelace Core API to ease development with sample data provided in data.js.

Currently, the script supports the following object types:

  • assets
  • assetTypes
  • customAttributes
  • categories
  • config
  • messages
  • ratings
  • transactions
  • users
  • workflows

To create an object, you need:

  • an identifier that can be used to be referenced in other objects (e.g. the property 'ownerId' for asset)
  • the payload that will be used to create the object

To reference the ID of another object, provide a string with the format: '[objectType]::[identifier]' (e.g 'users::employer1' to reference the user created with the key 'employer1').

Note: Transactions cannot be removed via API. Instead transactions are cancelled.

Local Stelace server

If you need to initialize the platform database with the exact state specified in data.js rather than updating existing resources, please first run yarn setup:instant locally to reset database before node run scripts/init-data.js.

You may also need to run yarn setup:instant in stelace-server when some object structure has changed after data migration or Stelace version upgrade.