Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mauricioacosta/ip-address-tracker


https://github.com/mauricioacosta/ip-address-tracker

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# Frontend Mentor - IP Address Tracker



This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.1.7.



## Development server



Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.



## Code scaffolding



Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.



## Build



Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.



## Running unit tests



Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).



## Running end-to-end tests



Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).



## Further help



To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).



# Challenge



![Design preview for the IP Address Tracker coding challenge](./design/desktop-preview.jpg)



## Welcome! 👋



Thanks for checking out this front-end coding challenge.



[Frontend Mentor](https://www.frontendmentor.io) challenges allow you to improve your skills in a real-life workflow.



**To do this challenge, you need a basic understanding of HTML, CSS and JavaScript.**



## The challenge



Your challenge is to build out this IP Address Tracker app and get it looking as close to the design as possible. To get the IP Address locations, you'll be using the [IP Geolocation API by IPify](https://geo.ipify.org/). To generate the map, we recommend using [LeafletJS](https://leafletjs.com/).



You can use any tools you like to help you complete the challenge. So if you've got something you'd like to practice, feel free to give it a go.



Your users should be able to:



- View the optimal layout for each page depending on their device's screen size

- See hover states for all interactive elements on the page

- See their own IP Address on the map on the initial page load

- Search for any IP addresses or domains and see the key information and location



---



⚠️ **IMPORTANT** ⚠️: To use the IP Geolocation API by IPify, you'll need to sign up for a free account. You won't need to add any cards details to do this and it's a very quick process. This will generate an API Key for you. Usually, you would be able to restrict your API Key to a specific URL (your own domain). This makes sure that other people can't use your API Key on their own websites. IPify doesn't have this feature, but because you aren't adding your card details, this isn't an issue. **So be sure to only sign up for the free account and DO NOT enter any card details**.



For the mapping API, we recommend using [LeafletJS](https://leafletjs.com/). It's free to use and doesn't require an API Key. If you decide to use another API, like Google Maps or Mapbox, be sure to secure your API Key. Here are guides for both Google Maps and Mapbox, be sure to read through them thoroughly:



- [API Key best practices from Google Developers](https://developers.google.com/maps/api-key-best-practices)

- [How to use Mapbox securely](https://docs.mapbox.com/help/troubleshooting/how-to-use-mapbox-securely/)



Exposing your API Key publicly can lead to other people using it to make requests for their own application if the proper precautions aren't in place. Please be sure you read the guides thoroughly and follow their recommendations.



**We don't take any responsibility if you expose your API Key while completing the challenge and have not secured it.**



## Where to find everything



Your task is to build out the project to the designs inside the `/design` folder. You will find both a mobile and a desktop version of the design to work to. 



The designs are in JPG static format. This will mean that you'll need to use your best judgment for styles such as `font-size`, `padding` and `margin`. This should help train your eye to perceive differences in spacings and sizes.



You will find all the required assets in the `/images` folder. The assets are already optimized.



There is also a `style-guide.md` file, which contains the information you'll need, such as color palette and fonts.



## Building your project



Feel free to use any workflow that you feel comfortable with. Below is a suggested process, but do not feel like you need to follow these steps:



1. Initialize your project as a public repository on [GitHub](https://github.com/). This will make it easier to share your code with the community if you need some help. If you're not sure how to do this, [have a read through of this Try Git resource](https://try.github.io/).

2. Configure your repository to publish your code to a URL. This will also be useful if you need some help during a challenge as you can share the URL for your project with your repo URL. There are a number of ways to do this, but we recommend using [Vercel](https://bit.ly/fem-vercel). We've got more information about deploying your project with Vercel below.

3. Look through the designs to start planning out how you'll tackle the project. This step is crucial to help you think ahead for CSS classes that you could create to make reusable styles.

4. Before adding any styles, structure your content with HTML. Writing your HTML first can help focus your attention on creating well-structured content.

5. Write out the base styles for your project, including general content styles, such as `font-family` and `font-size`.

6. Start adding styles to the top of the page and work down. Only move on to the next section once you're happy you've completed the area you're working on.

7. Create this project in angular >= 9



## Deploying your project



As mentioned above, there are a number of ways to host your project for free. We recommend using [Vercel](https://bit.ly/fem-vercel) as it's an amazing service and extremely simple to get set up with. If you'd like to use Vercel, here are some steps to follow to get started:



1. [Sign up to Vercel](https://bit.ly/fem-vercel-signup) and go through the onboarding flow, ensuring your GitHub account is connected by using their [Vercel for GitHub](https://vercel.com/docs/v2/git-integrations/vercel-for-github) integration.

2. Connect your project to Vercel from the ["Import project" page](https://vercel.com/import), using the "From Git Repository" button and selecting the project you want to deploy.

3. Once connected, every time you `git push`, Vercel will create a new [deployment](https://vercel.com/docs/v2/platform/deployments) and the deployment URL will be shown on your [Dashboard](https://vercel.com/dashboard). You will also receive an email for each deployment with the URL.