Quick Start for contributors

Local development environment setup guide.

Prerequisites

Package management tools

Windows

Install Chocolatey

MacOS

Install Homebrew

Development tools

info

All following commands fow windows use Git bash

Windows

Install Git for Windows. Recommended settings for better command line experience:

    - Add a Git Bash to Windows Terminal
    - Use Windows default console window

info

In Git bash as a Local Administrator

Choose latest 20.x version, if available

choco install -y nodejs --version=20.18.1

choco install -y yarn

MacOS

brew install git

brew install node@20

brew install yarn

Configuration

tip

You can skip this step if you have got access to ACE repository already

Create ssh key for ACE repositories

cd ~
mkdir -p .ssh
ssh-keygen -f ./.ssh/id_ace_rsa -t rsa -b 4096 -C "your_email@example.com"

# display public key
cat ./.ssh/id_ace_rsa.pub

Upload your public key to https://dev.azure.com/spnsdigital/_usersSettings/keys

Setup SSH host mapping

note

Make sure that your DevOps user is granted access to ACE git repositories

echo "Host ssh.dev.azure.com
  IdentityFile ~/.ssh/id_ace_rsa" >> ~/.ssh/config

mkdir -p ~/git/sapiens
cd ~/git/sapiens

Obtaining the source code

In ~/git/sapiens directory

git config --global core.autocrlf input
git clone git@ssh.dev.azure.com:v3/spnsdigital/sapiens-digital/sapiens-digital-ace-designer
git clone git@ssh.dev.azure.com:v3/spnsdigital/sapiens-digital/sapiens-digital-ace-marketplace
git clone git@ssh.dev.azure.com:v3/spnsdigital/sapiens-digital/sapiens-digital-ace-e2e

For community site (need to have GitHub access):

git clone https://github.com/Sapiens-Digital01/sapiens-digital-ace-community-site.git

Starting ACE 5 locally

Authentication and dependency installation

Obtain tools to connect to sapiens-registry npm feed

Windows

Install sapiens-digital-ace-designer dependencies

cd ~/git/sapiens/sapiens-digital-ace-designer
vsts-npm-auth -config .npmrc
yarn install

MacOS

vsts-npm-auth is not supported in Linux/Mac. Follow the steps below to set up your credentials:

1. Copy the following contents into your local ~/.npmrc file:

; begin auth token
//pkgs.dev.azure.com/spnsdigital/_packaging/sapiens-registry/npm/registry/:username=spnsdigital
//pkgs.dev.azure.com/spnsdigital/_packaging/sapiens-registry/npm/registry/:_password=COPY_YOUR_PERSONAL_ACCESS_TOKEN
//pkgs.dev.azure.com/spnsdigital/_packaging/sapiens-registry/npm/registry/:email=npm requires email to be set but doesn't use the value
//pkgs.dev.azure.com/spnsdigital/_packaging/sapiens-registry/npm/:username=spnsdigital
//pkgs.dev.azure.com/spnsdigital/_packaging/sapiens-registry/npm/:_password=YOUR_PERSONAL_ACCESS_TOKEN
//pkgs.dev.azure.com/spnsdigital/_packaging/sapiens-registry/npm/:email=npm requires email to be set but doesn't use the value
; end auth token

2. Generate a personal access token with packaging read and write scopes.

3. Encode your newly generated personal access token to base64:

echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64

4. In your ~/.npmrc file replace YOUR_PERSONAL_ACCESS_TOKEN placeholder with your base64 encoded token

5. Install sapiens-digital-ace-designer dependencies

cd ~/git/sapiens/sapiens-digital-ace-designer
yarn install

Starting the project

Start Designer & ACE runtime server

yarn install-start

Starting ACE 5 in Docker

If necessary it's possible to start ACE 5 in Docker

Prerequisites

Install Rancher Desktop During installation choose dockerd (moby) container runtime.

Install azure CLI (if using Azure AD login)

Windows

choco install -y azure-cli

MacOS

brew install azure-cli

Authentication

Login into docker registry to access the images

# authentication for users with access in Azure AD directory
az login
az acr login --name SapiensDEV

# authentication for users with service principals
docker login euadigportalcoredev02acr.azurecr.io

Launching application

docker-compose/up.sh current.yaml

Configure Keycloak as described here

Once all containers are started, open ACE Designer to access ACE user interface.