📗 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
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Series Special]

A single page app that displays a list of TV series, where users can react to each series by liking or commenting on it.

🛠 Built With

Tech Stack

• HTML
• JS
• Tailwind CSS

Database

• API dependdencies

Client

Server

• N/A

Database

• N/A

Key Feature

• Display TV titles, images and rankings
• Add and store likes
• Add and store comments

(back to top)

🚀 Live Demo

• Video presentation: Project video presentation

• GitHub Pages: Live version

(back to top)

(back to top)

💻 Getting Started

To get the content of this project locally you need to run the following commands in your terminal.

Prerequisites

• IDE (code editor) like: VScode, Sublime, etc
• Git

Setup

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

git clone https://github.com/maov19/javascript-capstone/

2. To access cloned directory run:

cd javascript-capstone

Install

To install linters and other project's dependencies run:

npm install

Usage

To run the project, execute the following command:

• Excute below command in the terminal to serve live

npm run dev

Run Test for Linters

For tracking linter errors locally you need to follow these steps:

1. For tracking linter errors in HTML files run:

npx hint .

2. For tracking linter errors in CSS or SASS files run:

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

3. For tracking linter errors in JavaScript files run:

npx eslint .

Deployment

You can deploy this project using:

• GitHub pages: Live
• Vercel

(back to top)

👥 Author:

👤 Authors

Shafiu Ibn Yushawu & Martin Ossa

• GitHub: @shafiuyushawu

• Twitter: @shafiuyushawu

• GitHub: @maov19

• Twitter: @maov08

(back to top)

🔭 Future Features

• Responsiveness for mobile version
• Functionality to request for reservations
• Functionality to link movie to IMDB movies

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Kindly raise issue here

(back to top)

⭐️ Show your support

If you like this project, kindly follow me on GitHub 😊

(back to top)

🙏 Acknowledgments

• Much acknowledgment goes to the creaters of both the TVMaze API and Involvement API for making such resourceful API available for us to practice.

(back to top)

📝 License

This project is MIT licensed.

(back to top)