diff --git a/README.md b/README.md index 02aac3f..dec867d 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,109 @@ -# Getting Started with Create React App +# Frontend Mentor - IP address tracker -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +![Design preview for the IP address tracker coding challenge](./design/desktop-preview.jpg) -## Available Scripts +## Welcome! 👋 -In the project directory, you can run: +Thanks for checking out this front-end coding challenge. -### `yarn start` +[Frontend Mentor](https://www.frontendmentor.io) challenges help you improve your coding skills by building realistic projects. -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +**To do this challenge, you need a basic understanding of HTML, CSS and JavaScript.** -The page will reload if you make edits.\ -You will also see any lint errors in the console. +## The challenge -### `yarn test` +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/). -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +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. -### `yarn build` +Your users should be able to: -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. +- 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 -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! +--- -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +⚠️ **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**. -### `yarn eject` +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: -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** +- [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/) -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. +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. -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. +**We don't take any responsibility if you expose your API Key while completing the challenge and have not secured it.** -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. +--- -## Learn More +Want some support on the challenge? [Join our Slack community](https://www.frontendmentor.io/slack) and ask questions in the **#help** channel. -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). +## Where to find everything -To learn React, check out the [React documentation](https://reactjs.org/). +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. -### Code Splitting +The designs are in JPG static format. Using JPGs will mean that you'll need to use your best judgment for styles such as `font-size`, `padding` and `margin`. -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) +If you would like the design files (we provide Sketch & Figma versions) to inspect the design in more detail, you can [subscribe as a PRO member](https://www.frontendmentor.io/pro). -### Analyzing the Bundle Size +You will find all the required assets in the `/images` folder. The assets are already optimized. -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) +There is also a `style-guide.md` file containing the information you'll need, such as color palette and fonts. -### Making a Progressive Web App +## Building your project -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) +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: -### Advanced Configuration +1. Initialize your project as a public repository on [GitHub](https://github.com/). Creating a repo will make it easier to share your code with the community if you need 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 web address. 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, and we provide some recommendations 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 to create 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. -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) +## Deploying your project -### Deployment +As mentioned above, there are many ways to host your project for free. Our recommend hosts are: -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) +- [GitHub Pages](https://pages.github.com/) +- [Vercel](https://vercel.com/) +- [Netlify](https://www.netlify.com/) -### `yarn build` fails to minify +You can host your site using one of these solutions or any of our other trusted providers. [Read more about our recommended and trusted hosts](https://medium.com/frontend-mentor/frontend-mentor-trusted-hosting-providers-bf000dfebe). -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) +## Create a custom `README.md` + +We strongly recommend overwriting this `README.md` with a custom one. We've provided a template inside the [`README-template.md`](./README-template.md) file in this starter code. + +The template provides a guide for what to add. A custom `README` will help you explain your project and reflect on your learnings. Please feel free to edit our template as much as you like. + +Once you've added your information to the template, delete this file and rename the `README-template.md` file to `README.md`. That will make it show up as your repository's README file. + +## Submitting your solution + +Submit your solution on the platform for the rest of the community to see. Follow our ["Complete guide to submitting solutions"](https://medium.com/frontend-mentor/a-complete-guide-to-submitting-solutions-on-frontend-mentor-ac6384162248) for tips on how to do this. + +Remember, if you're looking for feedback on your solution, be sure to ask questions when submitting it. The more specific and detailed you are with your questions, the higher the chance you'll get valuable feedback from the community. + +## Sharing your solution + +There are multiple places you can share your solution: + +1. Share your solution page in the **#finished-projects** channel of the [Slack community](https://www.frontendmentor.io/slack). +2. Tweet [@frontendmentor](https://twitter.com/frontendmentor) and mention **@frontendmentor**, including the repo and live URLs in the tweet. We'd love to take a look at what you've built and help share it around. +3. Share your solution on other social channels like LinkedIn. +4. Blog about your experience building your project. Writing about your workflow, technical choices, and talking through your code is a brilliant way to reinforce what you've learned. Great platforms to write on are [dev.to](https://dev.to/), [Hashnode](https://hashnode.com/), and [CodeNewbie](https://community.codenewbie.org/). + +We provide templates to help you share your solution once you've submitted it on the platform. Please do edit them and include specific questions when you're looking for feedback. + +The more specific you are with your questions the more likely it is that another member of the community will give you feedback. + +## Got feedback for us? + +We love receiving feedback! We're always looking to improve our challenges and our platform. So if you have anything you'd like to mention, please email hi[at]frontendmentor[dot]io. + +This challenge is completely free. Please share it with anyone who will find it useful for practice. + +**Have fun building!** 🚀 diff --git a/package.json b/package.json index 403b62c..664a159 100644 --- a/package.json +++ b/package.json @@ -6,8 +6,11 @@ "@testing-library/jest-dom": "^5.11.4", "@testing-library/react": "^11.1.0", "@testing-library/user-event": "^12.1.10", + "axios": "^0.21.1", + "leaflet": "^1.7.1", "react": "^17.0.2", "react-dom": "^17.0.2", + "react-leaflet": "^3.1.0", "react-scripts": "4.0.3", "web-vitals": "^1.0.1" }, diff --git a/public/index.html b/public/index.html index aa069f2..393e312 100644 --- a/public/index.html +++ b/public/index.html @@ -9,21 +9,20 @@ name="description" content="Web site created using create-react-app" /> + + - - React App diff --git a/src/App.css b/src/App.css index 74b5e05..cca57b3 100644 --- a/src/App.css +++ b/src/App.css @@ -1,38 +1,5 @@ -.App { - text-align: center; -} - -.App-logo { - height: 40vmin; - pointer-events: none; -} - -@media (prefers-reduced-motion: no-preference) { - .App-logo { - animation: App-logo-spin infinite 20s linear; - } -} - -.App-header { - background-color: #282c34; - min-height: 100vh; - display: flex; - flex-direction: column; - align-items: center; - justify-content: center; - font-size: calc(10px + 2vmin); - color: white; -} - -.App-link { - color: #61dafb; -} - -@keyframes App-logo-spin { - from { - transform: rotate(0deg); - } - to { - transform: rotate(360deg); - } +* { + margin: 0; + padding: 0; + box-sizing: border-box; } diff --git a/src/App.js b/src/App.js index 3784575..b2c4949 100644 --- a/src/App.js +++ b/src/App.js @@ -1,23 +1,19 @@ -import logo from './logo.svg'; -import './App.css'; +import React, { useState, useEffect } from "react"; +import axios from "axios"; +import Home from "./components/Home"; +import "./App.css"; function App() { + const [details, setDetails] = useState(""); + + useEffect(() => { + axios.get("https://ipapi.co/json/").then((response) => { + setDetails(response.data); + }); + }, []); return ( -
-
- logo -

- Edit src/App.js and save to reload. -

- - Learn React - -
+
+
); } diff --git a/src/components/Home.js b/src/components/Home.js new file mode 100644 index 0000000..1985c5a --- /dev/null +++ b/src/components/Home.js @@ -0,0 +1,23 @@ +import React, { useState } from "react"; + +const Home = ({ details }) => { + const [data, setData] = useState(""); + let textInput = React.createRef(); + + let onOnclickHandler = (e) => { + e.preventDefault(); + setData(textInput.current.value); + }; + + return ( +
+ + + +

your IP Address : {data}

+

your city :

+
+ ); +}; + +export default Home; diff --git a/src/design/active-states.jpg b/src/design/active-states.jpg new file mode 100644 index 0000000..086a8b9 Binary files /dev/null and b/src/design/active-states.jpg differ diff --git a/src/design/desktop-design.jpg b/src/design/desktop-design.jpg new file mode 100644 index 0000000..15d2510 Binary files /dev/null and b/src/design/desktop-design.jpg differ diff --git a/src/design/desktop-preview.jpg b/src/design/desktop-preview.jpg new file mode 100644 index 0000000..f431c87 Binary files /dev/null and b/src/design/desktop-preview.jpg differ diff --git a/src/design/mobile-design.jpg b/src/design/mobile-design.jpg new file mode 100644 index 0000000..4ecc9bf Binary files /dev/null and b/src/design/mobile-design.jpg differ diff --git a/src/images/favicon-32x32.png b/src/images/favicon-32x32.png new file mode 100644 index 0000000..1e2df7f Binary files /dev/null and b/src/images/favicon-32x32.png differ diff --git a/src/images/icon-arrow.svg b/src/images/icon-arrow.svg new file mode 100644 index 0000000..5e66747 --- /dev/null +++ b/src/images/icon-arrow.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/images/icon-location.svg b/src/images/icon-location.svg new file mode 100644 index 0000000..c3e438d --- /dev/null +++ b/src/images/icon-location.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/images/pattern-bg.png b/src/images/pattern-bg.png new file mode 100644 index 0000000..6ad1597 Binary files /dev/null and b/src/images/pattern-bg.png differ diff --git a/src/index.css b/src/index.css index ec2585e..af3544f 100644 --- a/src/index.css +++ b/src/index.css @@ -1,13 +1,8 @@ +@import url("https://fonts.google.com/specimen/Rubik"); + body { margin: 0; - font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', - 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', - sans-serif; + font-family: "Rubik", sans-serif; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; } - -code { - font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', - monospace; -} diff --git a/src/index.js b/src/index.js index ef2edf8..c2cdd53 100644 --- a/src/index.js +++ b/src/index.js @@ -1,14 +1,15 @@ -import React from 'react'; -import ReactDOM from 'react-dom'; -import './index.css'; -import App from './App'; -import reportWebVitals from './reportWebVitals'; +import React from "react"; +import ReactDOM from "react-dom"; +import "./index.css"; +import App from "./App"; +import reportWebVitals from "./reportWebVitals"; +// import "leaflet/dist/leaflet.css"; ReactDOM.render( , - document.getElementById('root') + document.getElementById("root") ); // If you want to start measuring performance in your app, pass a function diff --git a/style-guide.md b/style-guide.md new file mode 100644 index 0000000..fa4f576 --- /dev/null +++ b/style-guide.md @@ -0,0 +1,24 @@ +# Front-end Style Guide + +## Layout + +The designs were created to the following widths: + +- Mobile: 375px +- Desktop: 1440px + +## Colors + +- Very Dark Gray: hsl(0, 0%, 17%) +- Dark Gray: hsl(0, 0%, 59%) + +## Typography + +### Body Copy + +- Font size (text input): 18px + +### Font + +- Family: [Rubik](https://fonts.google.com/specimen/Rubik) +- Weights: 400, 500, 700 diff --git a/yarn.lock b/yarn.lock index eec90d5..918ffbf 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1437,6 +1437,11 @@ schema-utils "^2.6.5" source-map "^0.7.3" +"@react-leaflet/core@^1.0.2": + version "1.0.2" + resolved "https://registry.yarnpkg.com/@react-leaflet/core/-/core-1.0.2.tgz#39c6a73f61c666d5dcf673741cea2672fa4bbae1" + integrity sha512-QbleYZTMcgujAEyWGki8Lx6cXQqWkNtQlqf5c7NImlIp8bKW66bFpez/6EVatW7+p9WKBOEOVci/9W7WW70EZg== + "@rollup/plugin-node-resolve@^7.1.1": version "7.1.3" resolved "https://registry.yarnpkg.com/@rollup/plugin-node-resolve/-/plugin-node-resolve-7.1.3.tgz#80de384edfbd7bfc9101164910f86078151a3eca" @@ -2493,6 +2498,13 @@ axe-core@^4.0.2: resolved "https://registry.yarnpkg.com/axe-core/-/axe-core-4.1.2.tgz#7cf783331320098bfbef620df3b3c770147bc224" integrity sha512-V+Nq70NxKhYt89ArVcaNL9FDryB3vQOd+BFXZIfO3RP6rwtj+2yqqqdHEkacutglPaZLkJeuXKCjCJDMGPtPqg== +axios@^0.21.1: + version "0.21.1" + resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.1.tgz#22563481962f4d6bde9a76d516ef0e5d3c09b2b8" + integrity sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA== + dependencies: + follow-redirects "^1.10.0" + axobject-query@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/axobject-query/-/axobject-query-2.2.0.tgz#943d47e10c0b704aa42275e20edf3722648989be" @@ -4998,6 +5010,11 @@ follow-redirects@^1.0.0: resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.13.2.tgz#dd73c8effc12728ba5cf4259d760ea5fb83e3147" integrity sha512-6mPTgLxYm3r6Bkkg0vNM0HTjfGrOEtsfbhagQvbxDEsEkpNhw582upBaoRZylzen6krEmxXJgt9Ju6HiI4O7BA== +follow-redirects@^1.10.0: + version "1.14.1" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.1.tgz#d9114ded0a1cfdd334e164e6662ad02bfd91ff43" + integrity sha512-HWqDgT7ZEkqRzBvc2s64vSZ/hfOceEol3ac/7tKwzuvEyWx3/4UegXh5oBOIotkGsObyk3xznnSRVADBgWSQVg== + for-in@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/for-in/-/for-in-1.0.2.tgz#81068d295a8142ec0ac726c6e2200c30fb6d5e80" @@ -6783,6 +6800,11 @@ last-call-webpack-plugin@^3.0.0: lodash "^4.17.5" webpack-sources "^1.1.0" +leaflet@^1.7.1: + version "1.7.1" + resolved "https://registry.yarnpkg.com/leaflet/-/leaflet-1.7.1.tgz#10d684916edfe1bf41d688a3b97127c0322a2a19" + integrity sha512-/xwPEBidtg69Q3HlqPdU3DnrXQOvQU/CCHA1tcDQVzOwm91YMYaILjNp7L4Eaw5Z4sOYdbBz6koWyibppd8Zqw== + leven@^3.1.0: version "3.1.0" resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" @@ -8969,6 +8991,13 @@ react-is@^17.0.1: resolved "https://registry.yarnpkg.com/react-is/-/react-is-17.0.1.tgz#5b3531bd76a645a4c9fb6e693ed36419e3301339" integrity sha512-NAnt2iGDXohE5LI7uBnLnqvLQMtzhkiAOLXTmv+qnF9Ky7xAPcX8Up/xWIhxvLVGJvuLiNc4xQLtuqDRzb4fSA== +react-leaflet@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/react-leaflet/-/react-leaflet-3.1.0.tgz#42deb5e454518016eff8bc85511ae58812f910f5" + integrity sha512-kdZS8NYbYFPmkQr7zSDR2gkKGFeWvkxqoqcmZEckzHL4d5c85dJ2gbbqhaPDpmWWgaRw9O29uA/77qpKmK4mTQ== + dependencies: + "@react-leaflet/core" "^1.0.2" + react-refresh@^0.8.3: version "0.8.3" resolved "https://registry.yarnpkg.com/react-refresh/-/react-refresh-0.8.3.tgz#721d4657672d400c5e3c75d063c4a85fb2d5d68f"