Safe Client Gateway

Requirements

• Node 18.17.0 – https://nodejs.org/en/
• Docker Compose – https://docs.docker.com/compose/

Installation

corepack enable && yarn install

Running the app

1. Start Redis instance. By default, it will start on port 6379 of localhost.

docker compose up -d redis

2. Start the Safe Client Gateway

# development
yarn run start

# watch mode
yarn run start:dev

# production mode
yarn run start:prod

Test

# unit tests
yarn run test

# e2e tests
yarn run test:e2e

# test coverage
yarn run test:cov

Linter and Style Guide

We use ESLint as a linter and Prettier as a code formatter. You can run yarn run lint to execute ESLint and yarn run format to execute Prettier.

These checks can be automatically executed using Git hooks. If you wish to install the provided git hooks:

yarn install
yarn husky install