Schema

Data Model of your application describes in folder src/schema/entities.
Structure of folder schema:

• entities - folder where structure of data is described.
• mutations - folder where Customer Mutations are described.
• packages - folder where structure for Generate UML Diagrams

Entities

Before create entities your need to build Data Model. Each object of your Data Model is an entity.
Entity describes fields of object and relations between object and another object of model.

For example: describe object City and relation City with Country.

1. Go to folder src/schema/entities;
2. Create a new file with extension .ts Let see for example already creating Stutent.ts;

Note: File must be named by next rules:

• no spaces or other special characters;
• start with a capital letter.

3.Describe fields and relations of entity object:

    export default {
      name: 'Student',
      fields: {
        firstName: {
          indexed: true,
        },
        middleName: {},
        lastName: {
          identity: true,
        },
        uin: {
          identity: true,
        },
        dateOfBirth: {
          type: 'Date',
        },
        profile: {
          indexed: true,
          relation: {
            hasOne: 'StudentProfile#',
          },
        },
        group: {
          indexed: true,
          relation: {
            belongsTo: 'StudentsGroup#',
            opposite: 'students',
          },
        },
      },
    };

Fields of Entity

Field have next atributes:

• name - string, required attribute. Doesn't contain spaces or other special characters and start with a lowercase letter. It contain name of entity.
• description - string, it contain description of entity;

• fields - object, It contaian:

    fields: {
      ...
      <name>: {
        type: 'Date',
        description: 'description put here',
        required: true,
        indexed: true,
        identity: true,
        relation: <Relation description...>,
      },
      ...
    }
  

  1) <name> - string, required attribute. Doesn't contain spaces or other special characters and start with a lowercase letter.
  2) description - string, any text;
  3) type - string, default value is string. Types supported by project:

    string  
    boolean
    number
    Date
  

  4) required - boolean, default value false;
  5) indexed - boolean, default value false;
  6) identity - boolean, default value false;
  7) relation - object. Atribute which describes relation by object with another object of data model. (See Relation)