Open-source developer tools for Nigeria's 11-character NIPOST digital postcode.
Unofficial. Not made or endorsed by NIPOST.
Gatepost helps apps, websites and online stores accept the new postcode, such as EK-01-A03-FK-01, in TypeScript, PHP and WooCommerce. The tools check the form of a postcode offline, clean typed input, suggest a fix for a common typo and call NIPOST's gateway with your own API key.
- spec: the grammar, the client contract and the shared test vectors, at 0.4.0.
- js: the TypeScript core, client, web field and React wrapper, on npm as
@gatepost/core,@gatepost/client,@gatepost/fieldand@gatepost/react. Alpha. - php: the PHP package, on Packagist as
gatepost/postcode. Alpha. - woocommerce: the WooCommerce plugin. v0.1.0 is on GitHub. Not on WordPress.org yet.
- docs: the docs site, with guides, the API reference and a playground.
Read the docs or try the playground.
To help, read the contributing guide, pick a good first issue or ask in Discussions on any repo.
Report a security problem through the private form on the Security tab of the repo. Read SECURITY.md. Licence: Apache-2.0.