# medusa-plugin-ip-lookup-maxmind

> A Medusa plugin to lookup a user's country based on IP using MaxMind

Latest version **1.0.2** (published 2022-10-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install medusa-plugin-ip-lookup-maxmind
pnpm add medusa-plugin-ip-lookup-maxmind
yarn add medusa-plugin-ip-lookup-maxmind
bun add medusa-plugin-ip-lookup-maxmind
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-10-25 |
| First published | 2022-10-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Steven Nguyen |
| Maintainers | stnguyen90 |
| Keywords | medusa, medusa-plugin, maxmind, maxminddb, mmdb, geoip2 |

## Links

- npm: https://www.npmjs.com/package/medusa-plugin-ip-lookup-maxmind
- Repository: https://github.com/g33kdev/medusa-plugin-ip-lookup-maxmind
- Homepage: https://github.com/g33kdev/medusa-plugin-ip-lookup-maxmind#readme
- Issues: https://github.com/g33kdev/medusa-plugin-ip-lookup-maxmind/issues
- npm.io page: https://npm.io/package/medusa-plugin-ip-lookup-maxmind

## Dependencies (1)

- [@maxmind/geoip2-node](https://npm.io/package/@maxmind/geoip2-node.md) ^3.4.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-10-25
- 1.0.0 — 2022-10-19

## README

## medusa-plugin-ip-lookup-maxmind

![Medusa Hackathon 2022](docs/hackathon-banner.jpeg)

## About

### Participants

#### Steven

- GitHub - @stnguyen90
- Twitter - @stnguyen90
- Discord - BalistarDrake#3823

### Description

Lookup a user's region using [MaxMind](https://www.maxmind.com/en/geoip2-services-and-databases).

### Preview

![Preview](/docs/preview.png)

## Set up this plugin

### Requirements

This plugin is made to work with MedusaJS. You can find the documentation [here](https://medusajs.com/docs/). Here's what you'll need to get started with this plugin:

- [Node.js](https://nodejs.org/en/)
- [Medusa Store](https://docs.medusajs.com/quickstart/quick-start/)

### Install Project

1. Install the plugin:

```bash
npm install medusa-plugin-ip-lookup-maxmind

# or

yarn add medusa-plugin-ip-lookup-maxmind
```

2. Obtain a IP geolocation database file from MaxMind. You can download a GeoLite2 Free Geolocation Data [here](https://dev.maxmind.com/geoip/geolite2-free-geolocation-data).

3. Add the plugin to your `medusa-config.js` file (inside the `plugins` array):

```js
  {
    resolve: `medusa-plugin-ip-lookup-maxmind`,
    options: {
      maxmind_db_path: "<PATH_TO_MAXMIND_DB_FILE>",
    },
  }
```

---
_Source: https://npm.io/package/medusa-plugin-ip-lookup-maxmind · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._