Microverse README

📗 Table of Contents

• 📗 Table of Contents
• 📖 JavaScript Capstone Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 JavaScript Capstone Project

The JavaScript capstone project is about building our own web application based on two external APIs. First, we retrieve movies and TV Series from the TVmaze API and then record user interactions (likes and comments) using the Involvement API.

🛠 Built With

Tech Stack

Key Features

• Single page app
• Fetch movies
• Add likes to movies
• Add comments to movies
• Count movies, likes, and comments

(back to top)

🚀 Live Demo

• Live Demo Link
• Video presentation

(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:

• A PC running any operating system like Windows, Linux, or MacOS
• An Internet connection
• Knowledge of some basic Git commands
• A browser like Microsoft Edge, Google Chrome or Mozilla Firefox
• Git installed
• Webpack installed

Setup

• Link your PC to GitHub
• Clone this repository to your desired folder:

git clone https://github.com/Feliverse/JavaScript-Capston-Project.git

cd JavaScript-Capston-Project

• Open the file in your code editor

code .

• Setup JavaScript + CSS + HTML linters

Run the following codes in your project folder in your IDE:

npm install --save-dev hint@7.x

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

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

npx hint .

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

npx eslint .

Install

Install this project with:

• node_modules

npm install -g node-modules

• webpack

npm install -g webpack

npm install -g webpack-cli

• project dependencies

npm install

Usage

Start the server

npm run start

Run tests

To run tests,

• Install Jest and jsdom

npm install -g jest

npm install --save-dev jest-environment-jsdom

• Start the test

npm run test -- --watch

Deployment

Install the gh-pages npm package and designate it as a development dependency:

npm install gh-pages --save-dev

To deploy this project, run

npm run deploy

(back to top)

Authors

👤 Felipe Haybar

• GitHub: @Feliverse
• Twitter: @FelipeHaybar
• LinkedIn: FelipeHaybar

👥 Henschel Nketchogue M.

• GitHub: miltonHenschel
• LinkedIn: henschelnketchoguem
• Twitter: nketchogue
• Instagram: mpatchiehenschel

(back to top)

🔭 Future Features

• Improve design
• Add reservation feature

(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

• 

(back to top)

❓ FAQ

• How to fix JavaScript + CSS + HTML linter errors?

  • Kindly use the following in your project's root directory:

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

  npx eslint . --fix
  

(back to top)

📝 License

This project is MIT licensed.

(back to top)