[DRAFT] Vega - Stripes platform quick start guide

To run a few UI modules together follow the next steps:

1. Open the terminal and run
   stripes workspace



2. Select necessary modules (ui-checkin, ui-checkout, ui-circulation, ui-requests, ui-users, ui-servicepoints), additional libraries if necessary (stripes-components, stripes-smart-components, etc), platform (platform-complete), plugins if necessary and click Enter.
   
   You can use any combination of modules, plugins and libraries, but some of them are required for the correct work of the application (see table below).
   To work with all modules the Vega team is responsible for add all required and optional packages described in the table.  

   	Required	Optional
   module	ui-servicepoints	ui-checkin ui-checkout ui-circulation ui-requests ui-users
   platform	platform-complete
   library		stripes-components stripes-smart-components
   plugin		ui-plugin-find-user ui-plugin-find-instance

3. Go to "platform-complete" folder and execute the following command in terminal
   git checkout snapshot


4. Go to the folder "stripes" and run the following command in terminal
   yarn


5. If you are asked to select versions of some modules while package installation - select the last versions, if not - ignore this step.
   
   

6. Go to "platform-complete" folder and modify stripes.config.js.local file. It should have the structure described below.

   stripes.config.js.local

   module.exports = {
     okapi: { 'url': 'https://folio-snapshot-okapi.dev.folio.org', 'tenant':'diku' },
     config: {
       logCategories: 'core,path,action,xhr',
       logPrefix: '--',
       maxUnpagedResourceCount: 2000,
       showPerms: false
     },
     modules: {      
   	'@folio/checkout': '../ui-checkout',
       '@folio/servicepoints': '../ui-servicepoints',
       '@folio/checkin': '../ui-checkin',
       '@folio/circulation': '../ui-circulation',
       '@folio/requests': '../ui-requests',
       '@folio/users': '../ui-users',
    	'@folio/plugin-find-user': '../ui-plugin-find-user',
       '@folio/plugin-find-instance': '../ui-plugin-find-instance'
     },
     branding: {
       logo: {
         src: './tenant-assets/opentown-libraries-logo.png',
         alt: 'Opentown Libraries',
       },
       favicon: {
         src: './tenant-assets/opentown-libraries-favicon.png',
       },
     }
   };
   
   

   
   

   NOTE

   • property "modules" should contain paths only to installed modules and plugins
   • if some module/plugin was not installed in step 2, it should not be added to the config
   • installed libraries should not be added to the config.

   
   

7. Go to the root "stripes" directory and modify .stripesclirc.json file

   .stripesclirc.json

   {
     "okapi": "https://folio-snapshot-okapi.dev.folio.org",
     "tenant": "diku",
     "aliases": {},
     "configFile": "stripes.config.js.local",
     "port": 3000,
     "hasAllPerms": false
   }

8. Go to "platform-complete" folder and run in terminal
   stripes serve stripes.config.js.local


9. Open http://localhost:3000 and enjoy the app.
   
   
10. All changes that will be added to selected UI modules and libraries will automatically trigger rebuilding and then updating the application.