Prerequisits

• Install docker engine

Installation

Use the docker-compose.yml file to build and run a container.

1. Download the docker-compose.yml file from Github repo.

curl https://raw.githubusercontent.com/invoice-collector/invoice-collector/refs/heads/master/docker-compose.yml >> docker-compose.yml

1. Edit the docker-compose.yml and set the values for the env variables.

1. Build and run the container

sudo docker compose up -d

Contribution

There are two ways you can contribute to Invoice-Collector:

• Open a new issue to report a bug or request a new feature
• Create a new collector for the benefit of all

Developers

Full documentation available on the website.

Here is how to configure the project on your local machine.

• Clone the repo
• Install Google Chrome
• Create a .env file with all the required variables

npm run test.manual
Or
npm run test.manual <collector_id>
Or
npm run test.manual <collector_id> <first_param>
Or
npm run test.manual <collector_id> <first_param> <second_param> ...

Run a automatic test

npm run test.auto <collector_id>

Run on your local machine

npm run start

Run the debug container

docker-compose -f docker-compose-debug.yml up --build

You can then use the postman collection (_available soon_) to query the dev environment.