The Helpline Relationship Management (HRM) system is the backend for the Aselo system. It is built as an Express/NodeJS REST API accessed by the Aselo frontend. See aselo.org or contact Aselo for more information.
In order to prevent sensitive credentials to be leaked, please follow this instructions to setup git-secrets.
- Install git-secrets in your computer.
- Go into the repo root folder.
- Run
git secrets --register-aws. - Run
git config --local core.hooksPath .githooks/.
nvm or nvm-windows docker
Use nvm to ensure we use the same node/npm versions for each product. The first time you setup this repo (or if nvm use throws a missing version error), run nvm install to install the version of node specified in .nvmrc. Then run nvm use to switch to that version in the future. Without NVM: YMMV. nvm-windows does not support .nvmrc. Windows instructions are coming soon!
From the root directory run npm ci. This will install dependencies for all packages and manage their interdependencies for local development automatically using npm workspaces.
From the root directory run npm run build. This will compile all typescript files in the repo and output them to appropriate dist folders.
To run all tests across all of the monorepo packages, run npm test from the root directory.
There are several types of tests, (unit, service, e2e). These can be run using workspaces by running something like npm run -w hrm-service test:unit from the root directory. You can also run the tests by navigating into the package directory and running npm run test:service.
The primary test paths all do setup and teardown of required resources. This can add time to the test cycle. There are :run sub-scripts for tests that require setup and teardown like service and e2e tests. If you already have a test db docker container running, you can run these using workspaces by running something like npm run -w hrm-service test:service:run from the root directory. You can also run the tests by navigating into the package directory and running npm run test:service:run.
run npm start from the root directory to start the local data backends, hrm-service, and hrm-jobs packages.
TLDR: you can just run npm run start:db from the root directory to start a docker container with a postgres database for the HRM service to use.
From the root directory run npm run docker:compose:db:up. This will start a docker container with a postgres database for the HRM service to use.
The HRM node service will update the schema to the latest version when you run it.
You can then populate the DB with valid, up-to-date data by running the ./hrm-service/sql/multi-tenant-sample-data.sql, either with pgAdmin installed on your host, a CLI client running on the host, or the one running in the container
The db container created doesn't provide a volume on the host for storing data in persistently, meaning every time you restart it, it reverts to it's initial state.
This can be handy for some use cases like deterministic testing, but would get annoying for data to day dev. To allow your container to restart with the same data it had when it shut down, you should use npm run docker:compose:db-persistent:up instead.
Run npm run ssm:local from the root directory to download required secrets for local development from AWS SSM Parameter Store.
Run npm run migrate to run basic migrations against the database.
TLDR: you can just run npm run start:es from the root directory to start a docker container with an Elasticsearch database for the HRM service to use.
From the root directory run npm run docker:compose:es:up. This will start a docker container with an Elasticsearch database for the HRM service to use. Then run npm run es:create-index to create the indices.
Build the HRM service, packages, and jobs by running npm run build from the root directory.
If you haven't already, run npm run ssm:local from the root directory to download required secrets for local development from AWS SSM Parameter Store.
Run npm run start:service from the root directory to start the HRM service.
You can run the full stack quickly by running npm run build-and-start from the root directory (after running npm ci). This will start the hrm-service and hrm-jobs packages.
Running hrm jobs requires a lot of extra time and local resources. If you are only working on core hrm-service features, you can just run the hrm-service portion of the stack by running npm run build-and-start:service from the root directory.
If you modify a lambda job, you must redeploy with npm run localstack:deploy for localstack to pick up the changes. The npm run test:e2e script will do this for you, but will use the longer localstack:init script. For faster test running use npm run localstack:deploy and then npm run test:e2e --workspaces --if-present
Run npm run docker:compose::logs to tail logs from localstack, including output from lambda functions.
run npm run docker:compose:down to destroy the localstack and all docker based infrastructure running locally.
Package management is handled at the root level for sub modules. Since the package.lock is managed at the root level, you can't just run "npm add {package}" in a sub module. Instead, you must run "npm add {package} -w {sub module name}" from the root directory.