README.md

Description

The new FinBIF API, that FinBIF will migrate to.

See breaking changes against the old API

Development

Check the wiki for a more technically detailed documentation.

Stack

Nest

Installation & running

Fill in .env file, using .env.example as a template.

The app can be ran inside a docker, or directly on the host machine.

Docker (recommended)

Use docker to build & start the app:

npm run docker

Hint: The docker container runs any npm script, start:dev being the default. You can run other scripts like so:

npm run docker -- test:e2e-old

Without Docker

Install the dependencies:

$ npm ci

Install the following:

• Redis >= 5
• Oracle Instant Client

Running

1. Start Redis
2. Make sure the Oracle Instant Client is installed at /opt/oracle/instantclient or adjust the next step accordingly:

$ LD_LIBRARY_PATH=/opt/oracle/instantclient npm run start:dev

Test

Hint: The npm command works also with the aforementioned Docker container. These examples run npm directly for simplicity.

Unit tests

Unit tests cover so far only some core logic. They act also as documentation for how they are supposed to work.

With Docker:

npm run docker -- test

Without Docker:

npm test

Integration tests

Currently we rely on the e2e tests from the old api. Fill in integration-test/config.json and then you can run the tests:

With Docker:

$ npm run docker -- test:e2e-old

Without Docker:

$ LD_LIBRARY_PATH=/opt/oracle/instantclient npm run test:e2e-old

Contact

You can contact us by sending feedback from laji.fi.

License

MIT.