Sync forked repo

.gitignore

@@ -1,3 +1,8 @@
 primo-explore/custom/
 primo-explore/tmp/
-.idea/
+
+!primo-explore/custom/.gitignore
+!primo-explore/tmp/.gitignore
+
+.idea/
+package-lock.json

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Ex Libris, Ltd.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -35,36 +35,34 @@ This custom View folder can be downloaded from your Primo Back Office, by follow
 
 ## Installation
 
+Note: If you are not the Administrator of your machine, you might get into problems in the flow below, we recommend using the "Node.js command prompt (search for cmd in your pc to locate it) whenever the instructions below refer to "command line".
+
 1.  Download the project from this repository and place it on your computer
 
 2.  Unzip the file you downloaded to a preferred development project folder location
 
-3.  Download and install the [Node version 6.9.2](https://nodejs.org/download/release/v6.9.2/)
-
-4.  From command line, run the command : `npm install [email protected] -g`
+3.  Download and install the [Node version 16.17.0](https://nodejs.org/download/release/v16.17.0/)
 
-5.  Restart your computer
+4.  Restart your computer
 
-6.  From command line, run the command : `npm install -g gulp`
+5.  From command line, run the command : `npm install -g gulp`
 
-7.  In a <b>new</b> command line window, navigate to the project base directory (`cd \path\to\your\project\folder\primo-explore-devenv`)
+6.  In a <b>new</b> command line window, navigate to the project base directory (`cd \path\to\your\project\folder\primo-explore-devenv`)
 
-8.  From command line, run the command : `npm install` (This should install all node modules needed for gulp.)
+7.  From command line, run the command : `npm install` (This should install all node modules needed for gulp.)
 
     ![npm install image](./help_files/npmInstall.png "Running npm install")
 
-9.  Edit Gulp configuration file's <i>proxy server</i> setting, found at <b>gulp/config.js</b> : `var PROXY_SERVER = http://your-server:your-port` (Make sure to use your real Sandbox or Production Primo Front-End URL.) Note that for SSL environments (HTTPS) define the server as: `var PROXY_SERVER = https://your-server:443`
+8.  Edit Gulp configuration file's <i>proxy server</i> setting, found at <b>gulp/config.js</b> : `var PROXY_SERVER = http://your-server:your-port` (Make sure to use your real Sandbox or Production Primo Front-End URL.) Note that for SSL environments (HTTPS) define the server as: `var PROXY_SERVER = https://your-server:443`
 
-10. Populate your custom View package folder in the custom package folder ("...primo-explore\custom"), by either downloading the view code files from your Primo Back Office or using the [primo-explore-package GitHub repository](https://github.com/ExLibrisGroup/primo-explore-package "primo-explore-package repository")) to start a new package folder. (if you have already defined a view package and loaded it to the BO - make sure you download it or else you will not see, and may overwrite, your previous changes.)
+9. Populate your custom View package folder in the custom package folder ("...primo-explore\custom"), by either downloading the view code files from your Primo Back Office or using the [primo-explore-package GitHub repository](https://github.com/ExLibrisGroup/primo-explore-package "primo-explore-package repository")) to start a new package folder. (if you have already defined a view package and loaded it to the BO - make sure you download it or else you will not see, and may overwrite, your previous changes.)
 
    - If your custom view package folder were to be called "Auto1" then your development environment directory tree should look similar to this: 
    ![Directory tree image](./help_files/direcoryTree.png "Directory tree")
 
    - <b>IMPORTANT:</b> The name of your custom view package folder must match an <i>existing</i> view on the proxy server being referenced or the Gulp server will not function properly. For development from scratch, be sure to first create (or copy) a view using the Primo Back Office View Wizard; then you can accomplish your customizations locally using this document.
 
-11. Start your code customizations : 
-
-   - From command line, go to your custom view package folder : `cd primo-explore\custom\VIEW_CODE`
+10. Start your code customizations : 
 
    - From command line, run the command : `gulp run --view <the VIEW_CODE folder>` (This will start your local server.)
 
@@ -74,7 +72,7 @@ This custom View folder can be downloaded from your Primo Back Office, by follow
    - For Primo VE customers, add the --ve flag :
       `gulp run --view <the VIEW_CODE folder> --ve`
    - Open a browser and type in the following URL : `localhost:8003/primo-explore/?vid=your-view-code`  (Example: http://localhost:8003/primo-explore/search?vid=Auto1)
-   - For Primo VE customers open the following URL : `localhost:8003/discovery/?vid=your-view-code`
+   - For Primo VE customers open the following URL : `localhost:8003/discovery/?vid=your-institution-code:your-view-code`
 
    -  Now you should be able to to your customizations with real searches and results, from your previously defined proxy-server. Note: once you start working with this environment, you will discover that the best results are achieved by working in your browser's incognito mode; or you can clear your browser cache before you start the Gulp server.
 
@@ -93,6 +91,8 @@ This custom View folder can be downloaded from your Primo Back Office, by follow
       - [JavaScript](https://github.com/ExLibrisGroup/primo-explore-package/tree/master/VIEW_CODE/js "javascript documentation")
 
 
+Note: you have multiple options to edit the css file(custom1.css) and the js file(custom.js), some of them include methods of splitting your developments to seperate files. When using such methods - the custom1.css and custom.js files will be overriden by the different files when gulp is run. Place your custom css and js into files with different names such as custommodule.css or custom.module.js to have it concactinated into the custom css/js files.
+
 
 ## Publishing packages
 
@@ -113,3 +113,16 @@ Once you finish customizing the package, you can zip up that directory and uploa
     ![BO Image](./help_files/bo.png "BO up")
 
 5. Don't forget to <b>deploy</b> your changes
+
+
+## Publishing Primo-Studio addons
+
+Once you finish customizing the package, you can get it ready to be published to Primo-Studio.
+
+1. In a command line window, navigate to the project base directory : `cd \path\to\your\project\folder\primo-explore-devenv`
+
+2. From command line, run the command : `gulp prepare-addon` You will be prompted with a menu specifying all of the possible packages you can build.
+
+3. Once you finished running the script a folder containing the add-on will be created in `\path\to\your\project\folder\primo-explore-devenv\addons`.
+
+4. From the above folder you can publish your add-on to NPM and to Primo-Studio. For Instructions see: [Primo-Studio add-on tutorial](https://github.com/ExLibrisGroup/Primo-Studio-Addon-Tutorial)

addons/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore