Code Monkey home page Code Monkey logo

ip-lookup's Introduction

IP lookup

A simple Vue application that helps you retrieve and display information about your IP address. This app leverages the IPdata platform https://ipdata.co/ to get the IP information. The retrieved IP information is also used to retrieve weather and twitter trend information based on the location from your IP.




Table of Contents

Demo

Here is a working live demo: https://ip-web-lookup.herokuapp.com

Features

  • Get IP address information
  • Get weather information from IP
  • Get twitter trends by location from IP
  • Search functionality to get information on other IP addresses

Technologies

  • Vue
  • Ant Design Vue
  • Node.js
  • Express
  • IPData
  • Dark-sky API
  • Twitter API

Installation Setup

consumer_key
consumer_secret
access_token_key
access_token_secret

https://developer.twitter.com/en/apps - create an app and get the tokens above
ip_data_key - Checkout https://ipdata.co for guide on how to get an API key
DARKSKY_API - https://darksky.net/dev
NODE_ENV - production, development...
PRODUCTION_URL
PORT - Specify a different port for the server. Defaults to 4000
  • Clone repo:

    Open CMD for windows users, or any other terminal you use.

      git clone https://github.com/Nedson202/IP-lookup
    
  • Install project dependencies:

    This codebase uses the yarn package manager.

    Enter the following on your Terminal/CMD to change into the directory of the cloned repo and install all app dependencies

      Install the yarn package manager if you don't have it(optional).
    
      $ npm i -g yarn
    
    
      Change directory to cloned repo (IP-lookup)
    
      $ cd IP-lookup
    
      Install all dependencies
    
      $ yarn
    
  • Start the app:

    Note: In order to properly test, you would need to use ngrok or a similar service to assign you a remote host since localhost doesn't exactly give a searchable remoteAddress which can be sent to IPData.

    Enter the following on your terminal/cmd to start the app

      $ yarn start-all
    
  • Open browser

      Navigate to http://localhost:4000 on the browser
    
  • Additional setup: This app uses the dotenv package to load environment variables. For more info visit dotenv.

    • Create a .env file in the root directory of the codebase
    • Copy the content of the .env-sample file and add their corresponding values appropriately.

Language

  • Javascript

Dependencies

Click here to view all dependencies.

License

You can check out the full license here

This project is licensed under the terms of the MIT license.

ip-lookup's People

Contributors

nedson202 avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.