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

https://github.com/m-anwar-hussaini/javascriptcapstone

This project is a web application that provides information about different countries. It allows users to explore details such as the continent, capital, area, and population of various countries. Users can also view comments and add their own insights about specific countries.
https://github.com/m-anwar-hussaini/javascriptcapstone

api css html5 javascript jest testing webpac

Last synced: about 1 year ago
JSON representation

This project is a web application that provides information about different countries. It allows users to explore details such as the continent, capital, area, and population of various countries. Users can also view comments and add their own insights about specific countries.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Most Visitied Countries\] ](#-most-visitied-countries-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Configuring WebPack](#configuring-webpack)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 [Most Visitied Countries]

**[Most Visitied Countries]** is a web application that provides information about different countries. It allows users to explore details such as the continent, capital, area, and population of various countries. Users can also view comments and add their own insights about specific countries. The application utilizes the Involvement API to enable features like liking countries and commenting. It offers a user-friendly interface with pop-up windows to display country information and interact with the community through comments. The project aims to provide an engaging platform for users to learn and share knowledge about different countries.

## 🛠 Built With

1. ✅ **HTML**
2. ✅ **CSS**
3. ✅ **BootStrap**
4. ✅ **JavaScript**
5. ✅ **WebPack**
6. ✅ **LightHouse**
7. ✅ **WebHint**
8. ✅ **Styelint**
9. ✅ **ESLint**
10. ✅ **Git**
11. ✅ **Github**
12. ✅ **APIs**
13. ✅ **Jest**

### Tech Stack

Markup


  • HTML

  • MD markup

Style


  • CSS

  • Bootstrap

Dynamic


  • JavaScript

  • WepPack

  • APIs

### Key Features

- 🔰 **[Display countries with thier informations]**
- 🔰 **[Asynchronous javascript functionality]**
- 🔰 **[Professional design]**
- 🔰 **[Good look and feel]**
- 🔰 **[Responsive]**

(back to top)

## 🚀 Live Demo

- ✅ [Click](https://m-anwar-hussaini.github.io/JavaScriptCapstone/) to see live demo and watch this [video](https://drive.google.com/file/d/1Gjnf-vcZmFESFgXIL3QvS6qss1ailWN7/view?usp=sharing) for project short descriptions.

(back to top)

## 💻 Getting Started

**To get a local copy up and running, follow these steps.**

1. Download or clone this [repostory](https://github.com/M-Anwar-Hussaini/JavaScriptCapstone).
2. Provide a browser.
3. Open the `./dist/index.html` file using webpage browser.

### Prerequisites

**In order to run this project you need:**

- ✔ [Git](https://git-scm.com/downloads) installed in your machine.
- ✔ Sign in or sign up to your [Github](https://github.com/) account.
- ✔ A professional editer such as [VS Code](https://code.visualstudio.com/download).
- ✔ An Updated web browser such as Google Chrome, you can download it from [here](https://www.google.com/chrome/).
- ✔ [Node.js](https://nodejs.org/en/download) installed in your machine.
- ✔ Lighthouse.
- ✔ Webhint
- ✔ Stylelint
- ✔ ESLint
- ✔ WebPack

```sh
npm init -y
npm install --save-dev hint@7.x
npx hint .
```

- ✔ Stylelint

```sh
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
```

- ✔ ESLint

```sh
npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x
```

### Configuring WebPack

1. Initialize package.json:

```sh
npm init y
```

2. Install webpack:

```sh
npm install webpack webpack-cli --save-dev
```

3. Install CSS style loader:

```sh
npm install --save-dev style-loader css-loader
```

### Setup

- Clone this [repository](https://github.com/M-Anwar-Hussaini/JavaScriptCapstone) to your desired folder:

- Example commands:

```sh
cd [YOUR FOLDER]
git clone https://github.com/M-Anwar-Hussaini/JavaScriptCapstone.git
```

### Install

- Install this project by cloning or downloading the master branch of this [repository](https://github.com/M-Anwar-Hussaini/JavaScriptCapstone) and run `index.html` file on the root of repository.

### Usage

- To run the project, execute the following command:

```sh
cd [YOUR FOLDER]
git clone https://github.com/M-Anwar-Hussaini/JavaScriptCapstone.git
```

### Run tests

1. WebHint ☑

```
npx hint .
```

2. Stylelint ☑

```
npx stylelint "**/*.{css,scss}"
```

3. ESLint ☑

```
npx eslint .
```

### Deployment

**This project is deployed by the author, no permission for deployment by any other client.**

(back to top)

## 👥 Authors

👤 **Mohammad Anwar Hussaini**

- 👤 GitHub: [@Anwar Hussaini](https://github.com/M-Anwar-Hussaini)
- 👤 Twitter: [@MAnwarHussaini](https://twitter.com/MAnwarHussaini)
- 👤 LinkedIn: [Mohammad Anwar Hussaini](https://www.linkedin.com/in/mohammad-anwar-hussaini-876638267/)

👤 **Sergio Usma**

- GitHub: [@sergio-usma](https://github.com/sergio-usma)
- Twitter: [@VonUsma](https://twitter.com/vonusma)
- LinkedIn: [Sergio Andres Usma](https://www.linkedin.com/in/sergiousma/)

(back to top)

## 🔭 Future Features

- [ ] **[Release Version]**
- [ ] **[Host to a server]**
- [ ] **[Use bootstrap framework]**
- [ ] **[Use developer local storage]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/M-Anwar-Hussaini/JavaScriptCapstone/issues).

(back to top)

## ⭐️ Show your support

If you like this project, kindly drop a start for the [repository](https://github.com/M-Anwar-Hussaini/JavaScriptCapstone);

(back to top)

## 🙏 Acknowledgments

**I would like to thank the following individuals and organizations for their contribution to this project.**

- 🙏We would like to express my heartfelt gratitude to [**Microvere**](https://www.microverse.org/?grsf=mohammad-a-nbtazu) for the invaluable learning experience they have provided. The supportive community, dedicated mentors, and remote collaboration opportunities have enhanced my technical skills and prepared me for real-world projects. I extend my appreciation to the mentors and staff members for their guidance and support. The friendships and knowledge sharing within the Microverse community have made this journey truly rewarding.

(back to top)

## 📝 License

This project is [MIT](LICENSE) licensed.

(back to top)