Mise à jour de 'Devrules'

philc 2023-03-27 08:53:43 +00:00
parent 32aafedfe9
commit e1a05c7fb6

@ -94,7 +94,7 @@ Initialize a developer branch, each developer must create and checkout a new bra
* **Multilanguage management** depending of header.xlang request
- info:"|model|key" starting by | mean a file is available in ./nationchains/static/info/model_lg.json to match {key:"information in language lg}
## apXtrib Coding Convention
### apXtrib Coding Convention
Standard: Eslint 6 with a .eslintrc.js
@ -109,8 +109,14 @@ lib used for:
In general try to not install other lib in your dev. An apXtrib town mayor have to globaly valid to add a new lib into apxtrib so if you do then you can only use your town to provide your service and cannot use other town to deal wwith.
### apiDoc
## CORS and global
We use apidoc to generate the apXtrib documentation in nationscjains/apidoc/
Each route has to respect https://apidocjs.com/
Before a push please run yarn apidoc to update the documentation.
### CORS and global
global variable into node:
* ${__base} is the current dir where project are install in case you need absolute path.
@ -122,11 +128,11 @@ global variable into node:
## route template
### route template
A route analyse (data structure and user accesrights) a http request to act a model action
## model template
### model template
A model is a logical to apply onto an object. It is indepedant of the interface
export model to make it importable into route or any other app