Rest Countries

Table of Contents

1. About The Project
2. Built With
3. Getting Started
4. Usage
5. Roadmap
6. Contributing
7. License
8. Acknowledgments

About The Project

The Rest Countries is a React.js application that provides information about countries. Users can retrieve data about specific countries or get a list of all countries.

• Online Demo: Try this

Built With

• React.js
• Axios
• Jest
• React Testing Library

Getting Started

To run this project locally and access the application, follow these steps:

Prerequisites

You'll need to have the following software installed on your machine:

• Node.js and npm - Download Here

Installation

1. Clone the repository:

   git clone https://github.com/Chenmo1212/FE_Rest_Countries.git

2. Navigate to the project directory:

   cd FE_Rest_Countries

3. Install the project dependencies:

   npm install

4. Start the server:

   npm start

   The API will be available at http://localhost:3000.

Usage

You can use this application to search information about countries.

Roadmap

• Implement all countries list in the homepage
• Implement detail page of specific country
• Implement accessibility
• Add automated test See the open issues for a list of proposed features and known issues.

Contributing

Contributions are welcome! Here's how you can get involved:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Acknowledgments

Here are some resources and tools that were used in the development of this project:

• React.js
• Axios
• Jest
• React Testing Library