addressr

(β˜… 114)

Free Australian Address Validation, Search and Autocomplete

  • .codeclimate.yml
  • .dockerignore.tmpl
  • .dry-aged-deps.json
  • .gitignore
  • .log4brains.yml
  • .nvmrc
  • .nycrc.yml
  • .prettierignore
  • .prettierrc
  • .tflint.hcl
  • addressr-arch.monopic
  • addressr-arch.txt
  • addressr.svg
  • AGENTIC_RISK_REGISTER.md
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • cucumber.js
  • dagger-version.js
  • DECISION-MANAGEMENT.md
  • Dockerfile
  • eslint.config.js
  • LICENSE
  • LICENSE.md
  • lint-terraform.sh
  • netlify.toml
  • package-lock.json
  • package.json
  • plan.md
  • PRINCIPLES.md
  • README.md
  • RISK-POLICY.md
  • SECURITY.md
  • SUPPORT.md
  • TODO.md
  • turbo.json

# Installation Guide

1. Get the code
git clone https://github.com/mountain-pass/addressr

Downloads the entire project code from GitHub to your computer.

cd addressr

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull opensearchproject/opensearch:1.3.20

Type this command into your terminal and run it.

docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -e "plugins.security.disabled=true" opensearchproject/opensearch:1.3.20

Runs the built image as an actual container.

docker run -p 8080:8080 -e ELASTIC_HOST=host.docker.internal ghcr.io/mountain-pass/addressr

Runs the built image as an actual container.

docker run -v "$PWD/target:/home/nonroot/target" -e ELASTIC_HOST=host.docker.internal \

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install @mountainpass/addressr -g

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation