g33kdev / medusa-plugin-ip-lookup-maxmind

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

medusa-plugin-ip-lookup-maxmind

Medusa Hackathon 2022

About

Participants

Steven

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

Description

Lookup a user's region using MaxMind.

Preview

Preview

Set up this plugin

Requirements

This plugin is made to work with MedusaJS. You can find the documentation here. Here's what you'll need to get started with this plugin:

Install Project

  1. Install the plugin:
npm install medusa-plugin-ip-lookup-maxmind

# or

yarn add medusa-plugin-ip-lookup-maxmind
  1. Obtain a IP geolocation database file from MaxMind. You can download a GeoLite2 Free Geolocation Data here.

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

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

About

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

License:ISC License


Languages

Language:TypeScript 92.8%Language:JavaScript 7.2%