Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sedcakmak authored Aug 5, 2024
1 parent ff18c39 commit d716187
Showing 1 changed file with 30 additions and 55 deletions.
85 changes: 30 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,45 @@
# Getting Started with Create React App
# Frontend Mentor - REST Countries API with color theme switcher

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This is a solution to the [REST Countries API with color theme switcher on Frontend Mentor](https://www.frontendmentor.io/challenges/rest-countries-api-with-color-theme-switcher-5cacc469fec04111f7b848ca). Frontend Mentor challenges help you improve your coding skills by building realistic projects.

## Available Scripts
## Table of contents

In the project directory, you can run:
- [Overview](#overview)
- [The challenge](#the-challenge)
- [Screenshot](#screenshot)
- [Links](#links)
- [My process](#my-process)
- [Built with](#built-with)
- [Author](#author)

### `npm start`
## Overview

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
REST Countries API with color theme switcher is built by ReactJS and Styled Components. The website has a dark/light mode switcher.

The page will reload when you make changes.\
You may also see any lint errors in the console.
### The challenge

### `npm test`
Users should be able to:

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.
- Search for a country to view
- Filter the countries according to region
- Switch the light or dark mode of the website
- View the optimal layout for the site depending on their device's screen size
-
### Screenshot

### `npm run build`
![](./screenshot.png)

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
### Links

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
- Solution URL: ()
- Live Site URL: (https://countries-tau-weld.vercel.app/)

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Built with

### `npm run eject`
- [React](https://reactjs.org/) - JS library
- Styled Components - For styles

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

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/).

### Code Splitting

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)

### Analyzing the Bundle Size

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)

### Making a Progressive Web App

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)

### Advanced Configuration

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)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

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)
- Frontend Mentor - [@sedcakmak](https://www.frontendmentor.io/profile/sedcakmak)
- GitHub - [@sedcakmak](https://github.com/sedcakmak)

0 comments on commit d716187

Please sign in to comment.