README.md

VidVib

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
    • Presentation Video
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 VidVib

VidVib is a web application that displays a list of movies from an API. Users can like and add comments to a movie of their preference.

🛠 Built With

• HTML5
• CSS3
• JS
• ES6 Modules
• Webpack
• Jest

Tech Stack

HTML5

• Lesson on HTML5

CSS3

• Lesson on CSS3

JavaScript

• Lesson on JS

ES6 Modules

• Lesson on ES6 Modules

Webpack

• Lesson on Webpack

Key Features

• Display movies from API.
• Add and display likes on the home page.
• Add popup to display a movie.
• Add and display comments on the popup.

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Visual Studio Code
• Github Account
• Git Bash
• Node JS
• Jest library

Setup

Clone this repository to your desired folder: https://github.com/ticoniq/vidvib.git

Install

Install this project with:

  cd VidVib

  npm install 

  npm install --save-dev [email protected] [email protected] [email protected] [email protected]

Usage

To run the web application, execute the following command: Example command:

  npm run dev

Run tests

To run tests, run the following command: npm test Example command:

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

  npx eslint "**/*.js" --fix

(back to top)

🚀 Live Demo

• This is 'VidVib'Live Demo Link

(back to top)

🚀 Presentation

• This is 'VidVib presentation'Presentation Video

(back to top)

👥 Authors

👤 Tochi

• GitHub: [ticoniq]https://github.com/ticoniq
• Twitter: ticoniq
• LinkedIn: ticoniq

👤 Cosmas

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• More section inclusiveness
• Desktop Responsiveness
• Animation

(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 enjoy this project, I kindly request you to give it a star and consider following my social media pages.

(back to top)

🙏 Acknowledgments

This webapp is inspired by the movies from https://github.com/ticoniq/vidvib/issues. We would like to express my heartfelt gratitude to Microverse for providing me with this incredible project opportunity.

(back to top)

📝 License

This project is MIT licensed.

(back to top)