freegeoliteip

Version, currently main branch1 version
  • main branchlatestFeb 9, 2021

github.com/acidtib/freegeoliteip

Free IP GeoLocation web server

5 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  freegeoliteip:
    github: acidtib/freegeoliteip
    branch: main

main is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.36.0
License
MIT
Author
Dainel Vera
Target
  • freegeoliteip from src/application.cr

Dependencies

Runtime Dependencies

  • pg*github: will/crystal-pg
  • grip*github: grip-framework/grip
  • crystar*github: naqvis/crystar
  • jennifer*github: imdrasil/jennifer.cr, branch: master
  • mosquito*github: robacarp/mosquito
  • ipaddress*github: sija/ipaddress.cr
  • maxminddb*github: delef/maxminddb.cr
  • spec-grip*github: grip-framework/spec-grip

Development Dependencies

  • sam0.4.0github: imdrasil/sam.crdev
  • sentry*github: samueleaton/sentry, branch: masterdev

README

freegeoliteip

Trying to recreate the good old days of freegeoip

by the way, this project is still a work in progress

Installation

git clone https://github.com/arubinofaux/freegeoliteip.git
cd freegeoliteip
shards install

Usage

Prep local enviroment file

cp .env-example .env

Start the services

docker-compose up --build

visit http://localhost:8080

API

Return the geolocation of the visiting computer, the source IP address of the connection.

curl --request GET --url http://localhost:8080

Return the geolocation of the specified IP address.

curl --request GET --url http://localhost:8080/104.16.181.15

Development

TODO: Write development instructions here

Contributing

  1. Fork it (https://github.com/arubinofaux/freegeoliteip/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors