Welcome to GeoIP - the dynamic geolocation service that empowers your applications by detecting user IPs and providing essential geolocation information. Perfect for customizing user experiences with local language and currency settings! π
- IP Detection: Instantly identifies the user's IP address.
- Geolocation Data: Fetches country, city, latitude, longitude, and more.
- Language Customization: Sets the application's language based on the user's location.
- Currency Information: Provides local currency information to tailor financial interactions.
- Easy Integration: Designed with simplicity in mind for seamless integration into your system.
Integrating GeoIP into your project is as easy as pie! π₯§ Follow these steps to get started:
-
Clone the Repository
git clone https://github.com/notcoderguy/geoip.git cd geoip
-
Environment Setup
Make sure you have Docker installed and running on your machine. Then, build and run the containers:
docker-compose up --build
-
API Usage
Send a GET request to
/api/detect
to retrieve geolocation information:curl http://localhost:8000/api/detect
You can also get the geolocation information for a custom IP by sending a GET request to
/api/detect/{USER_IP}
:curl http://localhost:8000/api/detect/{USER_IP}
Replace
USER_IP
with the actual IP address you wish to query.
Dive deeper into GeoIP with our comprehensive API documentation available at /docs
. Learn about all the endpoints, request formats, and sample responses to make the most out of our service.
- Language Switcher: Automatically update your application's language based on user location.
- Currency Converter: Display prices in the user's local currency for a personalized shopping experience.
Got a spicy πΆοΈ idea or improvement? Contributions are more than welcome!
- Fork the repo.
- Create your feature branch (
git checkout -b feature/AmazingFeature
). - Commit your changes (
git commit -am 'Add some AmazingFeature'
). - Push to the branch (
git push origin feature/AmazingFeature
). - Open a pull request.
Distributed under the MIT License. See LICENSE
for more information.
Need help? Open an issue or contact us at [email protected]. We love to help!
Let's make the internet a more localized place, one IP at a time! πβ¨