Skip to content

invoice-collector/invoice-collector

Repository files navigation

Join Invoice-Collector on Discord

Invoice Collector

Invoice Collector is a free Docker image designed to retrieve invoices and receipts from suppliers. It seamlessly connects to customer portals, APIs, and email inboxes to automatically gather invoices.

Prerequisits

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.

  2. Build and run the container

sudo docker compose up -d

Contribution

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

Developers

Full documentation available on the website.

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

Run a manual test

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.

Packages

 
 
 

Contributors

Languages