jamespot-user-api 1.0.91 → 1.0.93

package/README-internal.md

@@ -4,13 +4,43 @@ The JamespotUserApi library facilitates the HTTPS calls to the Jamespot Apis. Th
 
 ## How to use
 
-## Installation
+## Run Web on Local
+
+This contains the JavaScript calls to the jamespot api (user-api) and lots of type definitions. Most of the Jamespot projects depends upon it. Therefore, it needs to be installed and build first.
 
 ```
-git clone https://github.com/Jamespot/jamespot-user-api.git
 npm ci
+npm run build
+```
+
+## Web project install order
+
+-   jamespot-user-api: https://github.com/Jamespot/jamespot-user-api
+-   jamespot-front-business: https://github.com/Jamespot/jamespot-front-business
+-   jamespot-react-components: https://github.com/Jamespot/jamespot-react-components
+-   jamespot-react-core: https://github.com/Jamespot/jamespot-react-core
+-   jamespot-react-extensions: https://github.com/Jamespot/jamespot-react-extensions
+
+### Run web on Local final
+
+Once everything has been installed run on local
+
+-   jamespot-react-core: `should run on localhost:3030`
+-   jamespot-react-extensions: `should run on localhost:3040`
+-
+
+```
+npm run local
 ```
 
+### Solidarity
+
+Once everything run, follow this doc to link your solidarity platform to your local dev:
+https://dokuwiki.teleport.jamespot.pro/doku.php?id=dev:utilitaires:solidarity:solidarity_machine&s%5B%5D=hook#installer_jdevhook_facultatif
+
+If you don't have a solidarity platform you can follow this to create one:
+https://dokuwiki.teleport.jamespot.pro/doku.php?id=dev:utilitaires:solidarity:branches
+
 ## Build
 
 | commande             | format du bundle | avec les mock | hot reload |