Capstone-Project-Setup-Kanban

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• 🙏 Acknowledgments
• 📝 License

📖 [BEST CARS SELL]

Best cars sell is a project that is allows you to see various models of the new cars of the year. requested from the API. This project is the final capstone project in module 2 in the Microverse program and it has been programmed by a group Alejandro Bernal Marín and Maher Ramadan.

🛠 Built With

Tech Stack

(back to top)

Key Features

• [ ] [Receiving models cars from API 'https://parallelum.com and render them in our app]
• [ ] [Pop up window when you press button "Comments" ]
• [ ] [Pop up window that renders all the info of the models cars and the comments and a form to add your comment!]
• [ ] [Sending the comments to the API: https://us-central1-involvement-api.cloudfunctions.net/ to be able to display all the models cars that we have in our application ]
• [ ] [Add likes when you press the heart like button]
• [ ] [Likes are sent to the API https://us-central1-involvement-api.cloudfunctions.net/, and then we receive them in our counter likes]
• [ ] [Counter of the items displayed at the top of the home page]
• [ ] [Counter of items function tested with jest]
• [ ] [Counter of the comments in each model's car]
• [ ] [Counter of comments function tested with jest]

(back to top)

🚀 Live Demo

To see the demo version : GitHub Pages

Video Documentation

Here we explain you our project!

video

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• [ ] A PC running any operating system like Windows, Linux, or MacOS
• [ ] An Internet connection
• [ ] Git installed
• [ ] Webpack installed
• [ ] Knowledge of some basic Git commands

Setup

1. Download the Zip file or clone the repo with:

   git clone https://github.com/Alejandro-Bernal-M/Capstone-Project-Setup-Kanban.git

2. To access cloned directory run:

   cd Capstone-Project-Setup-Kanban

3. Open it with the live server: npm start

Install

npm install

Usage

Start the server

npm run start

Run tests

To run Stylelint and ESLint tests, run the following commands respectively:

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

npx eslint .

run jest tests with "npm test"

Deployment

npm run deploy

• GitHub Pages was used to deploy this website
• For more information about publishing sources, see "About github page"

(back to top)

👥 Authors

👤 Maher ramadan

• GitHub: @maherramadan
• Twitter: [@maherramadan](coming soon)
• Linkedin:[@maherramadan][https://www.linkedin.com/in/maher-ramadan-655623a4/]

👤 Alejandro Bernal Marin

• GitHub: @Alejandro
• Twitter: @ABMblau
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [ ] Improve more cars models
• [ ] Making the navbar work with more sections
• [ ] Display more photos for the cars models and new prices and the option to pass to the next pages

(back to top)

🙏 Acknowledgments

I would like to thank - [ Microverse]

(back to top)

⭐️ Show your support

HAppy to have you here! If you like this project please Give us a ⭐️ ! Thank you so much!

(back to top)

📝 License

This project is MIT licensed.

(back to top)