Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/thomasjonstrup/rest-countries-api-with-color-theme-switcher

Frontend Mentor Challenge
https://github.com/thomasjonstrup/rest-countries-api-with-color-theme-switcher

frontend-mentor-challenges reactjs styled-components typescript

Last synced: 30 days ago
JSON representation

Frontend Mentor Challenge

Awesome Lists containing this project

README 

        
# Frontend Mentor - REST Countries API with color theme switcher



[![Netlify Status](https://api.netlify.com/api/v1/badges/5480e04e-2267-40ef-8ecd-cac2f2b60043/deploy-status)](https://app.netlify.com/sites/rest-countries-api-with-color-theme-switcher/deploys)



![Design preview for the REST Countries API with color theme switcher 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 good understanding of JavaScript.**



## The challenge



Your challenge is to integrate with the [REST Countries API](https://restcountries.eu) to pull country data and display it like in the designs.



You can use any JavaScript framework/library on the front-end such as [React](https://reactjs.org) or [Vue](https://vuejs.org). You also have complete control over which packages you use to do things like make HTTP requests or style your project.



Your users should be able to:



- See all countries from the API on the homepage

- Search for a country using an `input` field

- Filter countries by region

- Click on a country to see more detailed information on a separate page

- Click through to the border countries on the detail page

- Toggle the color scheme between light and dark mode *(optional)*



Want some support on the challenge? [Join our Slack community](https://www.frontendmentor.io/slack) and ask questions in the **#help** channel.



## Where to find everything



Your task is to build out the project to the designs inside the `/design` folder.



In this challenge, you will find mobile and desktop designs in light and dark mode color schemes for both pages.



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.



If you would like the Sketch file in order to see sizes etc, it is available to download from the challenge page on the site.



There are no assets for this challenge, as the country flags will be pulled from the [REST Countries API](https://restcountries.eu) and you can use an icon font library for the icons.



There is 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. If you'd like to try making your project fully responsive, we'd recommend checking out [Sizzy](https://bit.ly/fm-sizzy). It's a great browser that makes it easy to view your site across multiple devices.



## 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.



## Sharing your solution



There are multiple places you can share your solution:



1. Submit it on the platform so that other users will see your solution on the site. Here's our ["Complete guide to submitting solutions"](https://medium.com/frontend-mentor/a-complete-guide-to-submitting-solutions-on-frontend-mentor-ac6384162248) to help you do that.

2. Share your solution page in the **#finished-projects** channel of the [Slack community](https://www.frontendmentor.io/slack).

3. 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.



## Giving feedback



Feedback is always welcome, so if you have any to give on this challenge 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!** 🚀



## Community Sponsors



A massive thank you to our community sponsors!



- [Sizzy](https://bit.ly/fm-sizzy) is an extremely useful browser designed specifically to improve a developer's workflow when building websites. You can fire up multiple device emulators and run them all in sync while building out your web pages. Perfect for helping build fully responsive websites!

- [Diversify Tech](https://bit.ly/fem-diversify-tech) is an amazing resource for underrepresented people in tech. The site features job listings for anyone seeking new opportunities. The resource section is also full of useful links to dive into!

- [Dracula PRO](https://bit.ly/fem-dracula) is a beautiful dark theme to help keep you focused and productive while you code. The theme isn't just for your editor either. You can also apply it to your most-used apps like your terminal and even Slack!



This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).



## Available Scripts



In the project directory, you can run:



### `yarn start`



Runs the app in the development mode.


Open [http://localhost:3000](http://localhost:3000) to view it in the browser.



The page will reload if you make edits.


You will also see any lint errors in the console.



### `yarn test`



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.



### `yarn build`



Builds the app for production to the `build` folder.


It correctly bundles React in production mode and optimizes the build for the best performance.



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.



### `yarn eject`



**Note: this is a one-way operation. Once you `eject`, you can’t go back!**



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.



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.



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



You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).



To learn React, check out the [React documentation](https://reactjs.org/).