Microverse README Template

📗 Table of Contents

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

📖 JavaScript Capstone Project

In this project, we are setting up a Movies website with basic functionalities using JavaScript modules, Webpack and APIs.

New movies is a website that has two versions (desktop and mobile) and allows users to check the number of movies and interact by giving a like to their favorite movies and checking for other users' comments, as well as adding their own.

🛠 Built With

Tech Stack

Team Work

• JKanban Board

Building

• JavaScript
• HTML 5
• CSS 3
• ES6

Bundle

• WebPack
• NPM

Tests

• Jest
• Babel JS

Server

• WebPack Dev Server

Database

• TVMaze API

Key Features

• Like the favorite Movies
• Check for comments of other users in a pop-up
• Add new comment to the favorite movies

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

REVIEWS

For this project we performed several code reviews. You can find one of them performed by Sebastian here: #27

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Github account.
• Code editor (Visual Studio Code, Atom, etc.)
• WebPack
• Jestjs
• Babeljs

Setup

Clone this repository to your desired folder:

• cd my-folder
• git clone https://github.com/YKerroum/JS-capstone.git

Install

Install this project with:

• You'll need to install Webpack on your root directory by using the following command on your terminal:

  npm install webpack webpack-cli --save-dev

• Now you can use the npm run build command to create your new files on the dist folder by using the following command:

  npm run build

Usage

To run the project, execute the following command:

`npm start`

Run tests

To run tests, run the following command:

`npm test`

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Author1

• GitHub: @sebalp100
• LinkedIn: Sebastian Martin

👤 Author2

• GitHub: @YKerroum
• LinkedIn: Youssef KERROUM

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Hat tip to anyone whose code was used
• Microverse
• Traversy Media for his tutorial about JavaScript events (https://www.youtube.com/watch?v=JaMCxVWtW58&ab_channel=TraversyMedia)
• Black Code for his explanation about local storage (https://www.youtube.com/watch?v=xVwp_6ubgz0&ab_channel=blackcode)
• My coding partners for their help

(back to top)

📝 License

This project is MIT licensed.

(back to top)