/JS-Capstone

The Movies project is a web page that utilizes an external TV Maze API to showcase available movies. The project is built using HTML/CSS and JavaScript, including the ES syntax. It employs the Webpack module bundler .

Primary LanguageJavaScriptMIT LicenseMIT

Capstone-js

📗 Table of Contents

📖 Capstone-js

Capstone-js is a JavaScript single-page web application that retrieves a list of movies with unique IDs and detailed information about a selected movie from an API (TV maze). The web application interacts with another involvement API that records user interactions such as likes, comments and reservations.

🛠 Built With

Tech Stack

  • HTML
  • JS
  • css
Client
Server - Null
Database - Null

Key Features

  • Uses ES6 syntax
  • Applies Gitflow
  • Interaction with APIs
  • Unit tests with Jest
  • Use Webpack to bundle

🚀 Live Demo

(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 an IDE such as VS code, sublime, atom e.t.c, have Node.js installed:

Setup

Clone this repository to your desired folder:

  git clone https://github.com/mhnazary/JS-Capstone.git

Install

Install all dependencies required for this project with:

  cd JS-capstone
  npm install

Usage

To run the project have Node.js installed, and execute the following commands to initialize npm, install webpack locally, and install the webpack-cli (the tool used to run webpack on the command line)::

  $ npm init -y
  $ npm install webpack webpack-cli --save-dev

You can also use live reloading with webpack-dev-server using the following commands to install the web server, and run it:

  $ npm install --save-dev webpack-dev-server
  $ npm start

Run tests

To run tests, you can use testing frameworks such as Jest. Install and test with jest using:

  • no tests available
  $ npm install --save-dev jest
  $ npm test

Deployment

You can deploy this project using build tools such as webpack, Rollup, Parcel, e.t.c or even deploy using Github pages:

Example: To build for production with webpack, use the folowing commands:

  • Initialise npm package
  • ensure that webpack is installed
  • Build for production
 $ npm init -y
 $ npm run build

(back to top)

👥 Authors

👤 Mahram Hossain

👤 Betel Andarge

👤 Juan David Diaz

🔭 Future Features

  • Update UI styling 😁
  • Add more functionalities😎

🤝 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, kindly give it a ⭐️

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for the opportunity work on this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)