Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

To have access to the code of the Enterprise Search, Git must be installed, if you haven't done it yet, please refer to Prerequisites - Install Git

Downloading The Code

To download the code follow the steps:

  1. Clone the code the repository for the Enterprise Search

    Code Block
    languagetext
    themeFadeToGrey
    git clone https://source.digital.accenture.com/projects/ST/repos/search-stack
  2. Enter the folder of the repository just cloned

    Tip

    The default branch  is master, if you want to submit code, please create a branch or do a pull request to develop

  3. Initialize the submodules

    Code Block
    languagetext
    themeFadeToGrey
    git submodule update --init --recursive
  4. Install the server dependencies 

    Code Block
    languagetext
    themeFadeToGrey
    npm install
    Note

    In MacOs there is a know issue when executing npm install

    Code Block
    languagetext
    themeFadeToGrey
    gyp: No Xcode or CLT version detected!

    to solve this issue please follow the instructions from this link

  5. Install the user interface dependencies

    Code Block
    languagetext
    themeFadeToGrey
    cd ui
    npm install
  6. Build the user interfacer

    Code Block
    languagetext
    themeFadeToGrey
    npm run build
    Tip

    This can also be done from the root folder

...

Building the Enterprise Search

To execute Must of the code in Enterprise Search is interpreted, just go the to root folder and run the following commandonly the user interface code needs to be compiled, for this we got 2 options:

For development

The command below will build the use interface and create a folder dist, which is the actual code the server will for the ui, this code will be human readable making it ideal for debugging process. but slow for loading

Code Block
languagetext
themeFadeToGrey
npm run startbuild:dev

For production

Same as above but this code will be minified and uglyfied making it almost impossible to debug, but perfect to reduce size and loading timeEnterprise Search will start loading its components, you can start using it as soon as you see a message in the console similar to this one (can be slightly different):

Code Block
languagetext
themeFadeToGrey
**************************************************************************************
  _____       _                       _          ____                      _
 | ____|_ __ | |_ ___ _ __ _ __  _ __(_)___  ___/ ___|  ___  __ _ _ __ ___| |__
 |  _| | '_ \| __/ _ \ '__| '_ \| '__| / __|/ _ \___ \ / _ \/ _` | '__/ __| '_ \
 | |___| | | | ||  __/ |  | |_) | |  | \__ \  __/___) |  __/ (_| | | | (__| | | |
 |_____|_| |_|\__\___|_|  | .__/|_|  |_|___/\___|____/ \___|\__,_|_|  \___|_| |_|
                          |_|

 Mode: development
 PID: 3024
 Protocol: http
 Port: 3000
 Authentication: none
 NodeJS: 14.15.1

**************************************************************************************
npm run build
Tip

Both command can be execute from the root or the ui folder

Note

Be sure Elasticsearch is already running when attempting to start Enterprise Search