{"id":13588694,"url":"https://github.com/jhackshaw/iplocate","last_synced_at":"2025-04-08T06:32:33.873Z","repository":{"id":39699648,"uuid":"304422243","full_name":"jhackshaw/iplocate","owner":"jhackshaw","description":"Geolocate and plot ipv4 and ipv6 addresses","archived":false,"fork":false,"pushed_at":"2023-01-07T21:47:11.000Z","size":4810,"stargazers_count":91,"open_issues_count":39,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-06T08:43:03.173Z","etag":null,"topics":["aws","ipgeo","ipgeolocation","reactjs","terraform"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jhackshaw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-15T18:59:52.000Z","updated_at":"2024-10-08T15:37:41.000Z","dependencies_parsed_at":"2023-02-08T02:19:21.013Z","dependency_job_id":null,"html_url":"https://github.com/jhackshaw/iplocate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhackshaw%2Fiplocate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhackshaw%2Fiplocate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhackshaw%2Fiplocate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhackshaw%2Fiplocate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jhackshaw","download_url":"https://codeload.github.com/jhackshaw/iplocate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247792147,"owners_count":20996878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","ipgeo","ipgeolocation","reactjs","terraform"],"created_at":"2024-08-01T15:06:52.234Z","updated_at":"2025-04-08T06:32:28.850Z","avatar_url":"https://github.com/jhackshaw.png","language":"TypeScript","readme":"![IpLocate Deploy](https://github.com/jhackshaw/iplocate/workflows/IpLocate%20Deploy/badge.svg)\n![Frontend](https://github.com/jhackshaw/iplocate/workflows/IpLocate%20Frontend/badge.svg)\n![Backend](https://github.com/jhackshaw/iplocate/workflows/IpLocate%20Backend/badge.svg)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n\n## About\n\nIP Locate is a tool for querying and plotting geographic information for ipv4 and ipv6 addresses via the [MaxMind GeoLite2 dataset](https://www.maxmind.com/).\n\n![Screen Shot](https://repository-images.githubusercontent.com/304422243/0e06bd00-1e7d-11eb-8299-a3249d4d2c63)\n\n### Built with\n\n- [TypeScript](https://www.typescriptlang.org/)\n- [Jest](https://jestjs.io/)\n- [ReactJS](https://reactjs.org/)\n- [Styled Components](https://styled-components.com/)\n- [Fastify](https://www.fastify.io/)\n- [Terraform](https://www.terraform.io/)\n\n### development\n\nThe development environment is configured using `docker-compose`. In order to run iplocate locally:\n\n1. Configure environment:\n   - copy the dev.example.env file to a new file called .env: `cp example.env .env`\n   - add MaxMind account id and license key credentials to the `.env` file where appropriate. Access is free and an account can be created [here](https://www.maxmind.com/en/geolite2/signup).\n2. Start the environment:\n   - From the root of the project, start environment using docker: `docker-compose up --build`\n   - Local changes in `backend/src` and `frontend/src` will be hot-reloaded\n   - Other changes will require stopping and starting the environment\n3. Navigate to [http://localhost](http://localhost) in a browser\n\n### testing\n\nIn order to run unit tests\n\n1. Install backend dependencies (outside of docker)\n   - cd `./backend`\n   - `npm install`\n2. Install frontend dependencies (outside of docker)\n   - cd `./frontend`\n   - `npm install`\n3. From either directory\n   - Run unit tests: `npm run test`\n   - Run unit tests with coverage: `npm run test:coverage`\n   - Format code using prettier: `npm run format`\n   - Check formatting: `npm run format:check`\n\n### Contributing\n\nPull requests are welcome. Prior to committing, run unit tests and formatting. Code coverage is required to be above 90%.\n\n### CI/CD\n\nGitHub Actions is used for CI/CD. Backend CI configuration can be found in [.github/workflows/backend.yml](https://github.com/jhackshaw/iplocate/blob/master/.github/workflows/backend.yml), and frontend configuration can be found in [.github/workflows/frontend.yml](https://github.com/jhackshaw/iplocate/blob/master/.github/workflows/frontend.yml). Every PR triggers the following steps in both:\n\n1. Install nodejs and dependencies (npm ci)\n2. Ensure prettier code style (npm format:check)\n3. Run tests (npm run test:coverage)\n4. Build production application (npm run build)\n\nEvery push to master triggers the following deployment steps with the deploy workflow in [.github/workflows/deploy.yml](https://github.com/jhackshaw/iplocate/blob/master/.github/workflows/deploy.yml)\n\n1. Deploy infrastructure changes using terraform\n2. Deploy backend using serverless framework\n3. Deploy frontend to Netlify\n\n\n### Infrastructure setup\n\n![Diagram](https://raw.githubusercontent.com/jhackshaw/iplocate/master/infrastructure/diagram.png)\n\n\n![forthebadge](https://forthebadge.com/images/badges/check-it-out.svg)\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhackshaw%2Fiplocate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjhackshaw%2Fiplocate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhackshaw%2Fiplocate/lists"}