Tokenizer microservice with hexagonal architecture, developed using Nest and documented with OpenAPI

1. Clone the project
2. Navigate to the project folder, for example cd tokenizer
3. Create de redis resource:

$ kubectl apply -f etc/kubernetes/redis-deployment.yaml
$ kubectl apply -f etc/kubernetes/redis-service.yaml

4. Deploy and expose the tokenizer app:

$ kubectl apply -f etc/kubernetes/tokenizer-deployment.yaml
$ kubectl apply -f etc/kubernetes/tokenizer-service.yaml

5. Redirect tokenizer app traffic to localhost:

$ kubectl port-forward svc/app-tokenizer-service 3000:8080

6. Test the app. The apikey is required in the header, for example: x-api-key: pk_test_LsRBKejzCOEEWOsw. You can import the Postman collection located at etc/postman for this purpose.

1. Clone the project
2. Install dependencies

$ npm install

3. Run docker file to get Redis up locally

$ docker-compose up -d

4. Clone the file .env.example and rename it to .env, edit the new file if necessary
5. Build the app

$ npm run build

6. Run the app

$ node dist/main

7. Test the app. The apikey is required in the header, for example: x-api-key: pk_test_LsRBKejzCOEEWOsw. You can import the Postman collection located at etc/postman for this purpose.

This microservice has unit tests, integration tests and e2e tests

# run all tests
$ npm run test

# unit tests
$ npm run test:unit

# integration tests
$ npm run test:integration

# e2e tests
$ npm run test:e2e

This microservice has a coverage greater than 95%

# test coverage
$ npm run test:cov

All endpoints documented using OpenAPI

Go to http://{aplication_url}/docs for example http://localhost:3000/docs

AGPL licensed.