GeeGee platform

=> https://gitlab.com/validitylabs/internal-projects/geegee

Required VSCode extensions

• https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
• https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
• https://marketplace.visualstudio.com/items?itemName=rohit-gohri.format-code-action
• https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
• https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits

Commit convention

We are using conventional commit messages to keep everything clean. Please follow the commit message pattern as described here:

https://www.conventionalcommits.org/en/v1.0.0/

Husky pre commit validation

Resolve path issue (.husky/commit-msg: line 4: npx: command not found) in SourceTree as described here: typicode/husky#904

echo "export PATH="$(dirname $(which node)):$PATH"" > ~/.huskyrc

Local development setup

In order to setup your development environment, follow the following steps:

1. We require docker to be installed on your system.

2. The currently supported versions of node is defined in the .nvmrc file. We recommend to install NVM and then install the correct node version via nvm install.

3. Install project dependencies by executing the following commands in the root directory of the project:

   nvm use
   npm install

   Please note: Running npm install will automatically run initialization scripts for setting up the development environment. For example, the UID and GID of the own user is written into the file ".env" in the root directory. This is necessary so that files are not written by the CMS with the wrong permissions. If the .env file already exists, the script may ask if it is allowed to overwrite it. In case of problems the script can also be executed manually via npm run init.

   You may need to refresh your Google credentials file to ensure the Bucket access is working properly on your dev system: gcloud auth application-default login

4. Create and start docker containers:

   docker-compose up

LANDINGPAGE: http://localhost:3001

Run docker containers in production mode

docker-compose -f docker-compose.yml up

Test server

Test server LANDINGPAGE: https://t-geegee-landing.validity.io/

Deployment

For the test server deployment, the following commands needs to be executed in the projects root folder. Replace <BRANCH_TO_DEPLOY> with the branch name you want to deploy, it will be most likely the main branch.

git checkout test
git reset --hard <BRANCH_TO_DEPLOY>
git push --force origin test

Pushing into the test branch will automatically start the test server deployment. The state of the deployment can be monitored here: https://gitlab.com/validitylabs/internal-projects/geegee/-/pipelines

Production server

@TODO: URLs needs to be defined