2nd Capstone Project Of Microverse (Module Two)

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • 🚀 Live Demo
• 📺 Presentation
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Capstone-project]

🔊 This website is an Api-based webapp that get informations about breeds of dogs form this base Api and display only the 10 first breeds alphabetically display them and allow us to comment and like those breeds using this involvement Api

🛠 Built With

Tech Stack

Key Features

• Implement Linters
• Implement Github flow
• Implement Gitflow
• Implement webpack
• Implement APIs
• Implement Jest tests
• Implement Animate library

(back to top)

🚀 Live Demo

• Live Demo On Github Pages

(back to top)

📺 Presentation

• Zoom Presentation

(back to top)

💻 Getting Started

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

1.install git, if you already have git installed skip this step.

2.open command terminal

3.navigate to the directory you want remote directory to be cloned to

4.go to the github and copy the url of the repository

5.clone the repository by typing git clone the url copied in step4

6.Hit enter in the keyboard

7.navigate to the copy of your cloned repository using cd command

Prerequisites

In order to run this project you need:

• Basic knowdlenge of HTML, CSS, javascript and the code editor of your choice.
• Basic knowlege of the computer operating system.

Setup

Clone this repository to your desired folder: use command line

git clone https://github.com/AmineDerbal/capstone-project-2.git

Install

Install the dependencies with the command line :

1.npm install => to install all the dependencies used in the project.

2.suscribe to the dog Api webSite and get your API key

3.in the apiKey.js file inside src/modules folder assign you API KEY value to the apiKey variable

4.npm run build => to build this project from the source folder using webpack.

5.npm run start => in order to start a server and deploy the project localy

Run tests

To run tests, run the following command:

• npm test => to run the implemented jest tests in this project

"to check html css and javascript linter errors" Refer to this Documentation for information how to check styles error

(back to top)

👥 Authors

👤 Derbal Amine

• GitHub: github
• LinkedIn: LinkedIn

👤 Queenter Juma

• GitHub: github
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [ ] responsive for all devices
• [ ] implement additional home pages, one page per category of items
• [ ] implement a front end framework

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page

(back to top)

⭐️ Show your support

If you like this project please give it a ⭐

(back to top)

🙏 Acknowledgments

• the whole Microverse Community

(back to top)

📝 License

This project is MIT licensed.

(back to top)