Geolocate and plot ipv4 and ipv6 addresses
IP Locate is a tool for querying and plotting geographic information for ipv4 and ipv6 addresses via the MaxMind GeoLite2 dataset.
The development environment is configured using docker-compose
. In order to run iplocate locally:
cp example.env .env
.env
file where appropriate. Access is free and an account can be created here.docker-compose up --build
backend/src
and frontend/src
will be hot-reloadedIn order to run unit tests
./backend
npm install
./frontend
npm install
npm run test
npm run test:coverage
npm run format
npm run format:check
Pull requests are welcome. Prior to committing, run unit tests and formatting. Code coverage is required to be above 90%.
GitHub Actions is used for CI/CD. Backend CI configuration can be found in .github/workflows/backend.yml, and frontend configuration can be found in .github/workflows/frontend.yml. Every PR triggers the following steps in both:
Every push to master triggers the following deployment steps with the deploy workflow in .github/workflows/deploy.yml