Instructions definition

Instruction	Definition	Model	Route	View	Database
help	Show some help to understand Nodea.	-	-	-	-
restart	Restart the application server.	-	-	-	When server restarts, new tables are created by sequelize synchronization.
npm install ([value])	Install a specific npm package in the application folder. If no specific package given, it will execute npm install command in workspace folder.	-	-	-	-

Instruction	Definition	Model	Route	View	Database
deploy [branch]	Since 3.0.2 Deploy the application on the connected ‘Cloud’ environment for testing / production purpose. You can also specify the git branch to deploy.	-	-	-	When server restarts, new tables are created by sequelize synchronization on the cloud database. toSyncProd.json file is also executed ( sql alter instruction ).
save	Execute a git push on the connected distant repository.	-	-	-	-
reload	Execute a git pull on the connected distant repository.	-	-	-	-
git commit	Execute a git commit on the current application.	-	-	-	-
git status	Execute a git status on the current application.	-	-	-	-

Instruction	Definition	Model	Route	View	Database
select application [value]	Select and set the application in current session.	-	-	-	-
create application [value]	Create a new application with the given name.	Copy from the structure/template and many changes from the generator app procedure creation.	Copy from the structure/template and many changes from the generator app procedure creation.	Copy from the structure/template and many changes from the generator app procedure creation.	Copy from the structure/template and many changes from the generator app procedure creation.
delete application [value]	Delete the specified application. /!\ Warning /!\ The distant repository if exist will also be deleted.	Remove everything.	Remove everything.	Remove everything.	Remove everything.
DEPRECATED: add component cra	Create new module with activity report purpose.	See component section for more information.	See component section for more information.	See component section for more information.	See component section for more information.
ON MAINTENANCE: add component chat	Create component chat on application.	New models: channel.js, channel_message.js, user_channel.js, user_chat.js, chat.js	New route: chat.js	File modification: main_layout.dust	New table from new models
set logo	Set a logo on the application.	-	-	File modification: main_layout.dust File modification: login_layout.dust	-
remove logo	Remove the actual logo on the application.	-	-	File modification: main_layout.dust File modification: login_layout.dust	-
set theme [theme]	Apply CSS theme on the application	-	-	File modification: main_layout.dust File modification: login_layout.dust	-
list theme	List all the available themes for the application.	-	-	-	-

Instruction	Definition	Model	Route	View	Database
select module [value]	Select and set the module in current session.	-	-	-	-
add module [value]	Create a new module on the application.	-	New file: routes/module.js	New file: views/layout_m_module.dust	-
delete module [value]	Delete the specified module.	-	Remove file: routes/module.js	Remove file: views/layout_m_module.dust	-
list module	List all module of the application.	-	-	-	-
add component agenda (called [name])	Add the component agenda to the actual module.	New model: models/agenda.js New model: models/agenda_event.js New model: models/agenda_category.js	New file: routes/agenda.js New file: routes/agenda_event.js New file: routes/agenda_category.js	Add folder: views/agenda.js Add folder: views/agenda_event.js Add folder: views/agenda_category.js	Generate 2 new table (agenda_event & agenda category) with foreign key between them
delete component agenda (called [name])	Delete the specify component agenda.	Remove model: models/agenda.js Remove model: models/agenda_event.js Remove model: models/agenda_category.js	Remove file: routes/agenda.js Remove file: routes/agenda_event.js Remove file: routes/agenda_category.js	Remove folder: views/agenda.js Remove folder: views/agenda_event.js Remove folder: views/agenda_category.js	Remove 2 table: agenda_event & agenda category
DEPRECATED: set layout [value]	Change de layout display of a module.	-	-	File modification: layout_m_module.dust	-
DEPRECATED: list layout	List all available layout.	-	-	-	-

Instruction	Definition	Model	Route	View	Database
select entity [value]	Select and set the entity in current session.	-	-	-	-
list entity	List all entities of the application.	-	-	-	-
add entity [value]	Add a new entity on the current module.	New file: model/entity.js New file: models/attributes/entity.json New file: models/options/entity.js	New file: routes/entity.js	New folder: views/entity/ New file: views/entity/create.dust & create_field.dust New file: views/entity/update.dust & update_field.dust New file: views/entity/show.dust & show_field.dust	New table
delete entity [value]	Delete the specified entity.	Remove file: model/entity.js Remove file: models/attributes/entity.json Remove file: models/options/entity.js	Remove file: routes/entity.js	Remove folder: views/entity/	-
add param entity [value]	Add a new param entity on the current module.	New file: model/entity.js New file: models/attributes/entity.json New file: models/options/entity.js	New file: routes/entity.js	New folder: views/entity/ New file: views/entity/create.dust & create_field.dust New file: views/entity/update.dust & update_field.dust New file: views/entity/show.dust & show_field.dust	New table
set column [field] [value]	Hide or show a column on the current entity. Two choices: show / hide	-	-	Modify file: views/entity/list_field.dust	-
hide column [field]	Hide a column on the current entity.	-	-	Modify file: views/entity/list_field.dust	-
show column [field]	Show a column on the current entity.	-	-	Modify file: views/entity/list_field.dust	-
delete tab [tab]	Delete a specific tab (hasMany, hasOne, File Storage, …) on an entity.	If tab is about an entity relation: Remove relation key in: models/options/entity.js	-	Modify file: views/entity/show_field.dust	Remove relation foreign key if necessary
entity [entity] has one [target] (called [name])	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.	New key in: models/options/entity.js New key in: models/options/target.js If subentity generate all file for new entity (see add entity instruction)	If subentity generate all file for new entity (see add entity instruction)	Modify file: views/entity/show_field.dust	Add foreign key on entity table
entity [entity] has many [target] (called [name])	Generate hasMany 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.	New key in: models/options/entity.js New key in: models/options/target.js If subentity generate all file for new entity (see add entity instruction)	If subentity generate all file for new entity (see add entity instruction)	Modify file: views/entity/show_field.dust	Add foreign key on target table
entity [entity] has many preset [target] (called [name])	Generate hasMany relation between 2 entities. The target entity have to exist before executing this instruction. Generate hasMany relation but the purpose is to link already existing row instead of creating new ones. Note: ‘preset’ term can also be replaced by ‘existing’ => has many existing	New key in: models/options/entity.js New key in: models/options/target.js	-	Modify file: views/entity/show_field.dust	Add foreign key on target table
add component status (called [name])	Generate component status on the entity. See … for more information.	New model for history table	New route for history table	Modify file: views/entity/show_field.dust	New table for history status Status foreign key on entity table
delete component status (called [name])	Delete component status on an entity.	Remove history model	Remove history route	Modify file: views/entity/show_field.dust	Remove table for history status Remove status foreign key on entity table
create component file storage (with name [name])	Create component file storage on entity.	Add file storage entity	Add field storage component route	Modify file: views/entity/show_field.dust	New file storage table Foreign key between file storage table and entity
add component address (called [name])	Create component address on entity.	New model: models/address_entity.js	If it's the first component address on this app: routes/address_settings.js	Modify file: views/entity/create_field.dust, update_field.dust, show_field.dust	New table: address_entity Add foreign key on entity
delete component address	Remove component address on entity.	Remove model: models/address_entity.js	-	Modify file: views/entity/create_field.dust, update_field.dust, show_field.dust	Remove table: address_entity Remove foreign key on entity
set icon [icon]	Set a Font Awesome icon on the entity.	-	-	Modify file: views/layout_m_module.dust Modify file: views/modules/m_module.dust	-
list icon	Will basically give you the Font Awesome link to find the perfect icon !	-	-	-	-
add widget piechart on entity [entity] for field [field] (without legend)	Add widget on actual module home about the specify entity.	-	-	Modify file: views/modules/m_module.dust	-
add widget last records on entity [entity] (limited to [value]) records with columns [columns]	Add widget on actual module home about the specify entity. Show the last row created for an entity.	-	-	Modify file: views/modules/m_module.dust	-
add widget [widget] (on entity [entity])	Add a widget to the module. See widget section for more information.	-	-	Modify file: views/modules/m_module.dust	-
delete widget [widget]	Delete a specific widget.	-	-	Modify file: views/modules/m_module.dust	-
delete widgets of entity [entity]	Delete all widget of an entity.	-	-	Modify file: views/modules/m_module.dust	-
add component document template (with name [name])	Add component document template on an entity.	-	-	Modify file: views/entity/show_field.dust	New foreign key on entity table with the document template table
delete component document template	Remove component document template from the current entity	-	-	Modify file: views/entity/show_field.dust	Remove foreign key on entity table

Instruction	Definition	Model	Route	View	Database
add field [value]	Add a new field on the current entity.	New entry in model/attributes/entity.json	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	Add column on entity table
list field	List all fields of the application.	-	-	-	-
set field [field] [value]	Set the field property with four choice available: required / optional unique / non-unique	Set required or unique key in model/attributes/entity.json in field definition.	-	If required, add a red star after the field label to indicate that the field is required	Execute SQL query with ALTER TABLE on the field column.
set field [field] attribute [attribute] [value]	Add a field attribute on the HTML element. Example: set field myField attribute maxLength 50	-	-	Modify the field HTML element to add the attribute	-
create field [value] with type [type]	Add a new field with given type. See all the available type here: URL Coming soon	New entry in model/attributes/entity.json	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	-
add field [field] with type enum and values [values]	Add a new field with type enum. Values must be comma separated.	New entry in model/attributes/entity.json	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	-
add field [field] with type radio and values [values]	Add a new field with type radio. Values must be comma separated.	New entry in model/attributes/entity.json	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	-
create field [field] related to [entity] (using [target_field])	Create hasOne relation between 2 entities in the form of an enum field. Using option let you specify with field to show in enum from the target entity.	New key in: models/options/entity.js New key in: models/options/target_entity.js	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	Generate foreign key on entity table
create field [field] related to many [entity] (using [target_field])	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.	New key in: models/options/entity.js New key in: models/options/target_entity.js	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	Generate foreign key on target table
create field [field] related to many [entity] with type checkbox (using [target_field])	Create hasOne relation between 2 entities in the form of an radio field. Using option let you specify with field to show in radio from the target entity.	New key in: models/options/entity.js New key in: models/options/target_entity.js	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	Generate foreign key on entity table
add title [title] (after [field])	Add a title after a field if specified.	-	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	-
remove title [title]	Remove a title.	-	-	Add HTML in entity create_field.dust, update_field.dust and show_field.dust	-

¶ Introduction

¶ How does an instruction work ?

¶ Definition

¶ Global Instruction

¶ Online Instruction

¶ Application Instruction

¶ Module Instruction

¶ Entity Instruction

¶ Field Instruction