Skip to content

This project is a dynamic web application that leverages the REST Countries API to fetch and display comprehensive information about countries from around the world. The app is designed to provide an intuitive and user-friendly interface where users can explore and learn about different countries effortlessly.

Notifications You must be signed in to change notification settings

AfuhFlynns/rest-countriesapi-html-js

Repository files navigation

REST Countries API Frontend App

A simple, elegant, and responsive frontend application that leverages the REST Countries API to provide information about countries worldwide. This project showcases your skills in modern web development, including html, css, javascript, jQuery and responsive design.

Features

  • Fetch and display country data from the REST Countries API.
  • Search for countries by name.
  • Filter countries by region.
  • View detailed information about a selected country, including:
    • Population
    • Region
    • Subregion
    • Capital
    • Currencies
    • Languages
    • Border countries
  • Dark and Light mode toggle for an enhanced user experience.

Technologies Used

  • React: Frontend framework for building dynamic user interfaces.
  • TypeScript: Type-safe JavaScript for more robust and maintainable code.
  • TailwindCSS or CSS/SASS (specify what you used): For beautiful, responsive styling.
  • REST Countries API: Data source for country information.

Installation and Setup

  1. Clone the Repository

    git clone https://github.com/AfuhFlynns/Flint_RestCountries_Api_React.git
  2. Install Dependencies

    npm install
  3. Start the Development Server

    npm start or npm run dev
  4. Build for Production

    npm run build

Usage

  1. Search for a country using the search bar.
  2. Filter countries by selecting a region from the dropdown menu.
  3. Click on a country card to view detailed information about the country.
  4. Toggle between light and dark modes using the mode switcher.

API Reference

https://restcountries.com/v3.1/all

Base URL

https://restcountries.com/v3.1/all

Endpoints Used

  1. Get All Countries
    GET /all
    

Future Enhancements

  • Add user authentication for personalized experiences.
  • Save favorite countries to a profile.
  • Include maps for geographical context.
  • Add more filtering options, such as by population size or area.

Contributing

Contributions are welcome! Feel free to fork this repository and submit a pull request.

  1. Fork the repository.
  2. Create a new branch.
    git checkout -b feature-name
  3. Commit your changes.
    git commit -m "Add some feature"
  4. Push to the branch.
    git push origin feature-name
  5. Open a pull request.

License

This project is licensed under the MIT License.

Acknowledgments

  • REST Countries API for the amazing data.
  • Open-source libraries and tools that made this project possible.

Made with ❤️ by Your Name

About

This project is a dynamic web application that leverages the REST Countries API to fetch and display comprehensive information about countries from around the world. The app is designed to provide an intuitive and user-friendly interface where users can explore and learn about different countries effortlessly.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published