Contribute
Issues and pull requests are welcome. Join us on the GitHub repository.
Repository layout
This is an npm workspaces monorepo.
| Path | Contents |
|---|---|
packages/jp-local-gov-id | JS API |
packages/jp-local-gov-id-data | Split JSON datasets |
scripts/ | Data generation from Excel, etc. |
site/ | This documentation site |
docs/ | Internal specs |
Getting started
npm install
npm test
npm run build
Regenerate data (Ministry of Internal Affairs Excel → split JSON):
npm run generate
Run the docs site locally:
npm run dev:site
Guidelines
- Bug fixes, docs improvements, and tests are welcome
- Please open an Issue first for breaking API or data-format changes
- See
docs/in the repository for detailed specs
Licensed under MIT.