This monorepo contains the @netresearch/postdirekt-autocomplete-library and @netresearch/postdirekt-autocomplete-sdk npm packages.
Before you can start working on the Autocomplete monorepo, you need to have Node.js
installed on your machine. The required version is pinned in .nvmrc (currently Node 22).
To download Node.js visit https://nodejs.org/en/download/.
NOTE: You can use a tool like NVM
or N to install and manage multiple node versions.
With NVM, run nvm install in the repo root to automatically install and switch to the correct version.
This project uses Yarn 4 via Node.js corepack. Enable it with:
corepack enableYarn will be automatically resolved from the packageManager field in package.json -- no separate installation needed.
You can verify your setup by running the following commands in your terminal at the root of the repo:
node -v
yarn -vYour Node.js version should match .nvmrc, and yarn -v should show 4.x.
Once you have Node.js and corepack enabled, set up the development environment by running the following at the root of the repo:
yarnOnce you have installed all the dependencies, you can build both packages by running the following command at the root of the repo:
yarn buildThis folder contains the @netresearch/postdirekt-autocomplete-sdk, responsible for abstracting away the Deutsche Post Direkt Autocomplete 2.0 API.
See Readme.
This folder contains the @netresearch/postdirekt-autocomplete-library, responsible for registering input listeners on given input fields (street address, city and postcode) and fetching address suggestions from the Autocomplete API via the autocomplete-sdk package.
See Readme.
You can run the tests with:
yarn testTo run the linter:
yarn lintYou can build ES2017 compatible artifacts (this is what's published on npm) with:
yarn buildYou can also build ES5 compatible artifacts (output in <rootDir>/dist) with:
yarn build:es5