Below you will find all the instructions that you can execute on a Nodea application. These instructions will add the different elements directly into the application code and your application will be directly usable and testable with what you have just added.
| Instruction | Category | Definition | Example |
|---|---|---|---|
| help | Simple | Show some help to understand Nodea. | “help” |
| restart | Infra | Restart the application server. | “restart server” |
| npm install [value] | Infra | Install a specific npm package in the application folder. If no specific package given, it will execute npm install command in workspace folder. | “npm install exceljs” |
| Instruction | Category | Definition | Example |
|---|---|---|---|
| deploy [branch] | Infra |
Since 3.0.2 Deploy the application on the connected ‘Cloud’ environment for testing / production purpose. You can also specify a git branch to deploy. |
“deploy” “deploy feature/my-feature” |
| save | Infra | Execute a git push on the connected distant repository. |
“save” “git push" |
| reload | Infra | Execute a git pull on the connected distant repository. |
“reload” “git pull” |
| git commit | Infra | Execute a git commit on the current application. | “git commit” |
| git status | Infra | Execute a git status on the current application. | “git status” |
| Instruction | Category | Definition | Example |
|---|---|---|---|
| select application [value] | Simple | Select and set the application in current session. | “select application myApp” |
| create application [value] | Infra | Create a new application with the given name. | “add application myApp” |
| delete application [value] | Infra |
Delete the specified application. /!\ Warning /!\ The distant repository if exist will also be deleted. |
“delete application myApp” |
| set logo | Design | Set a logo on the application. | “set logo” |
| remove logo | Design | Remove the actual logo of the application. | “remove logo” |
| set theme [theme] | Design | Apply CSS theme on the application | “set theme nodea-dark” |
| list theme | Simple | List all the available themes for the application. | “list theme” |
| Instruction | Category | Definition | Example |
|---|---|---|---|
| select module [value] | Simple | Select and set the module in current session. | “select module myModule” |
| add module [value] | Simple | Create a new module on the application. | “add module myModule” |
| delete module [value] | Simple | Delete the specified module. | “delete module myModule” |
| list module | Simple | List all modules of the application. | “list module” |
| add component agenda (called [name]) | Component | Add the component agenda to the current module. | “add component agenda called my Agenda” |
| delete component agenda (called [name]) | Component | Delete the specify component agenda. | “delete component agenda called my Agenda” |
| Instruction | Category | Definition | Example |
|---|---|---|---|
| select entity [value] | Simple | Select and set the entity in current session. | “select entity my Entity” |
| list entity | Simple | List all entities of the application. | “List entity” |
| add entity [value] | Simple | Add a new entity on the current module. | “add entity my Entity” |
| delete entity [value] | Simple | Delete the specified entity. | “delete entity my Entity” |
| add param entity [value] | Simple | Add a new parameters entity on the current module. | “add param entity my Entity” |
| set column [field] [value] | Design |
Hide or show a column when listing entity records Two choices: visible / hidden |
“set column myField visible” |
| hide column [field] | Design | Hide a column on the current entity. | “hide column myField” |
| show column [field] | Design | Show a column on the current entity. | “show column myField” |
| delete tab [tab] | Relation | Delete a specific tab (hasMany, hasOne, File Storage, …) on an entity. | “delete tab myTab” |
| entity [entity] has one [target] (called [name]) | Relation | Generate hasOne relation between 2 entities. If the target exist then it generate the link between them. If the target does not exist then it generate a subentity and link them. | “entity myEntity1 has one myEntity2 called relationBetween1&2” |
| entity [entity] has many [target] (called [name]) | Relation | Generate hasMany relation between 2 entities. If the entity target already exists, it generates the link between them. If the target does not exist then it generates a subentity and link them. | “entity myEntity1 has many myEntity2 called relationBetween1&2” |
| entity [entity] has many preset [target] (called [name]) | Relation |
Generate hasMany relation between 2 entities. The target entity must have been created before executing this instruction. Generates hasMany relation and enables to select existing rows in a list instead of creating new ones. Note: ‘preset’ term can also be replaced by ‘existing’ => has many existing |
“entity myEntity1 has many preset myEntity2 called relationBetween1&2” “entity myEntity1 has many existing myEntity2 called relationBetween1&2” |
| add component status (called [name]) | Component | Generate component status on the entity. See … for more information. | “add component status called my Workflow” |
| delete component status (called [name]) | Component | Delete component status on an entity. | “delete component status called my Workflow” |
| create component file storage (with name [name]) | Component | Create component file storage on entity. | “add component file storage called my Documents” |
| add component address (called [name]) | Component | Create component address on entity. | “add component address called my Address” |
| delete component address | Component | Remove component address on entity. | “delete component address” |
| delete component address called [name] | Component | Remove a named component address on entity | “delete component address called my Address” |
| set icon [icon] | Design | Set a Font Awesome icon on the entity. | “set icon plane” |
| list icon | Simple | Will basically give you the Font Awesome link to find the perfect icon. | “list icon” |
| add widget piechart on entity [entity] for field [field] (without legend) | Design | Add widget on actual module home about the specify entity. | “add widget piechart on entity myEntity for field myField” |
| add widget last records on entity [entity] (limited to [value]) records with columns [columns] | Design | Add widget on actual module home about the specify entity. Show the last row created for an entity. | “add widget last records on entity myEntity limited to 5 records with columns myField” |
| add widget [widget] (on entity [entity]) | Design | Add a widget to the module. See widget section for more information. | “add widget stats on entity myEntity” |
| delete widget [widget] | Design | Delete a specific widget. | “delete widget stats” |
| delete widgets of entity [entity] | Design | Delete all widget of an entity. | “delete widgets of entity myEntity” |
| add component document template (with name [name]) | Component | Add component document template on an entity. | “add component document template called Impression Documents” |
| delete component document template | Component | Remove component document template from the current entity | “delete component document template called Impression Documents” |
|
Enable tracking on entity [entity] Activer la traçabilité sur l’entité [myentity] |
Component | Active data entity tracking on an entity. | “enable tracking on entity Person” |
| Show tracking on entity [entity] | Component | Display the tab “traceability” for admin users | “show tracking on entity Person” |
| Instruction | Category | Definition | Example |
|---|---|---|---|
| add field [value] | Simple | Add a new field on the current entity. | “add field myField” |
| list field | Simple | List all fields of the application. | “list field” |
| set field [field] [value] | Simple |
Set the field property with four choice available:
|
“set field myField required” |
| set field [field] attribute [attribute] [value] | Simple | Add a field attribute on the HTML element. | “set field myField attribute maxLength 50” |
| create field [value] with type [type] | Simple |
Add a new field with given type. See all the available type here: URL Coming soon |
“create field Birthdate with type date” |
| add field [field] with type enum and values [values] | Simple | Add a new field with type enum. Values must be comma separated. | “add field City with type enum and values New York, Paris, London” |
| add field [field] with type radio and values [values] | Simple | Add a new field with type radio. Values must be comma separated. | “add field Gender with type radio and values Man, Woman” |
| add field [field] related to [entity] (using [target_field]) | Relation | Create hasOne relation between 2 entities in the form of an enum field. Using option let you specify wich field to show in enum from the target entity. | “add field User Gender related to User using Gender” |
| add field [field] related to multiple [entity] (using [target_field]) | Relation | Create hasMany relation between 2 entities in the form of an multiple enum field. Using option let you specify with field to show in enum from the target entity. | "add field Tags related to multiple Tag using Label" |
| add field [field] related to multiple [entity] with type checkbox (using [target_field]) | Relation | Create hasMany relation between 2 entities in the form, and display a radio input field. Using option let you specify with field to show in radio from the target entity. | “add field Categories related to multiple Category with type checkbox using Label" |
| add title [title] (after [field]) | Design | Add a title after a field if specified. | “add title Title 1” |
| remove title [title] | Design | Remove a title. | “remove title Title 1” |