@e-invoice-eu/server
v2.1.15
Published
REST API for generating EN16931 conforming electronic invoices
Maintainers
Readme
@e-invoice-eu/server
This directory contains the source code of the E-Invoice-EU web service with a RESTful API. The service is written with NestJS.
Pre-requisites
- NodeJS 17 or newer (currently tested with NodeJS 18, 20, and 22)
- A package manager like bun, npm, yarn, pnpm, ...
Installation
$ bun installThis may warn about "husky" missing. Just run bun install again in order
to fix this.
If you do not like bun, replace it with npm, yarn, pnpm or whatever
is currently hyped.
Running the app
# development
$ bun run start
# watch mode
$ bun run start:dev
# production mode
$ bun run start:prodTest
# unit tests
$ bun run test
# e2e tests
$ bun run test:e2e
# test coverage
$ bun run test:covRunning in a Container
By far the easiest way is to run the application in a software container.
Pull the Docker image:
$ docker pull gflohr/e-invoice-eu:latestRun the container:
$ docker run -it --rm -d -p 3000:3000 --name e-invoice-eu gflohr/e-invoice-eu:latestIf you want to debug issues, omit the option -d so that you can see the
output of the application running inside of the container.
Access the application from your host computer:
$ curl http://localhost:3000/api/format/listOr you can see the OpenAPI/Swagger documentation:
curl http://localhost:3000/apiIt probably makes more sense to open that URL in the browser.
See the documentation for information on how to create e-invoices with the API.
Reporting Bugs
Please report bugs at https://github.com/gflohr/e-invoice-eu/issues.
Copyright
Copyright (C) 2024-2025 Guido Flohr [email protected], all rights reserved.
This is free software available under the terms of the WTFPL.
Disclaimer
This free software has been written with the greatest possible care, but like all software it may contain errors. Use at your own risk! There is no warranty and no liability.
