A simple, no-nonsense IP checker website. https://ipaddr.lol
Go to file
Quinn Lane daae0674bd
Add Open Graph support
Signed-off-by: Quinn Lane <hello@quinnlane.dev>
2022-06-08 10:48:14 -04:00
.idea Add Open Graph support 2022-06-08 10:48:14 -04:00
.yarn 📦️ Clean up packaging 2022-06-07 18:57:55 -04:00
public Add Open Graph support 2022-06-08 10:48:14 -04:00
src 🐛 Fix bug where the dynamic pretty endpoint returns a null response 2022-06-07 15:34:01 -04:00
.dcignore 🎉 Start basic project with Express template 2022-02-26 20:20:26 -05:00
.gitignore 🎉 Start basic project with Express template 2022-02-26 20:20:26 -05:00
.gitlab-ci.yml Configure SAST in `.gitlab-ci.yml`, creating this file if it does not already exist 2022-02-26 10:00:02 +00:00
.yarnrc.yml 📦️ Clean up packaging 2022-06-07 18:57:55 -04:00
CODE_OF_CONDUCT.md 🧑‍💻 Make the README (and related files) look presentable 2022-03-22 01:26:25 -04:00
CONTRIBUTING.md 🧑‍💻 Make the README (and related files) look presentable 2022-03-22 01:26:25 -04:00
Dockerfile 🚀 Update Dockerfile 2022-06-08 10:33:04 -04:00
LICENSE 📄 Change license from ARR to BSD 3-Clause "New" or "Revised" License 2022-02-27 02:27:58 -05:00
Procfile.txt 🚀 Add Heroku Procfile 2022-06-07 18:27:13 -04:00
README.md 🧑‍💻 Improve the README and add templates 2022-06-07 14:21:58 -04:00
THIRD_PARTY_LIBRARIES.md 📄 Fix THIRD_PARTY_LICENSES.md to reflect the new GeoIP library 2022-06-06 13:30:10 -04:00
package.json 📦️ Clean up packaging 2022-06-07 18:57:55 -04:00
template.env 🧑‍💻 Improve the README and add templates 2022-06-07 14:21:58 -04:00
tsconfig.json Create basic structure with API (/api/pretty, /api/:ip/pretty, /api/just-ip) 2022-02-28 02:52:40 -05:00
yarn.lock 📦️ Clean up packaging 2022-06-07 18:57:55 -04:00

README.md

Quinn's IP Checker

A simple application that shows your (or any other that you feed into the system) IP and info about said IP.

Demo

Demos will go here once they are created.

Authors

Contributing

Contributions are always welcome!

See our contribution guide for ways to get started. Also, please make sure that you are adhering to this project's code of conduct.

License

This application is licensed under the BSD 3-Clause License. If you are not a legal expert, TL;DRLegal has a great explaination of the license.

Acknowledgements

  • Thank you to MaxMind for providing the geolocation data through GeoLite2
  • This application uses multiple libraries for accomplishing its goals, many of which have differing licenses. To comply with said licenses, and to make the lawyers go away, a copy of each license has been included with the software.

Environment Variables

The environment variables GEO_ACCOUNTID and GEO_LICENSE. These correspond to your MaxMind account ID and your license for GeoLite2 respectively.

Run Locally

  1. Clone the project
  git clone https://gitlab.com/Identithree/ip
  # OR if you use glab cli
  glab repo clone https://gitlab.com/Identithree/ip
  1. Go to the project directory
  cd ip
  1. Install dependencies
  yarn install
  1. Rename template.env to .env and fill in your details

  2. Build and start the server

  yarn run build
  yarn run start

Deployment

Coming Soon™

API Reference

We have two public APIs that are available for use. One is static and the other is dynamic. Both share most common functionality except for a few key differences discussed on the wiki in full detail.

Documentation

We host documentation via the integrated wiki

Support

For support, email our service desk or submit an issue on our issue tracker. Both will funnel into the issue tracker.