WikiShow

📗 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
• ❓ FAQ
• 📝 License

📖 WikiShow

WikiShow is a website that allows the user to seek for TV Shows. He can view informations about any show, comments it or even likes it.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript
• Webpack
• Babel
• Jest
• Node.js/npm

Server

• TVmaze API
• Involvement API

Key Features

• The user can search for movies by querying using key words
• The user can leave comments on a movie
• The user can like a movie

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

1. Start cloning this repository by entering the following command:

git clone https://github.com/adebsa2401/Microverse-Capstone-2.git

2. Install npm dependencies by running

   npm i

3. Build assets by running

   npm run build

4. Finally run

   npm start

   to start webpack local server. The project's entry file index.html should automatically open in your browser. If it doesn't, open your browser and head over to the following url: http://localhost:8080

Prerequisites

In order to run this project you need:

• node.js / npm

Setup

Clone this repository to your desired folder:

git clone https://github.com/adebsa2401/Microverse-Capstone-2.git

Install

Install this project with:

npm i

Usage

To run the project, execute the following command:

npm run build

npm start

Run tests

To run tests, run the following command:

npm run test

Deployment

You can deploy this project using:

git subtree push --prefix dist origin gh-pages

(back to top)

👥 Authors

👤 Ben Sales

• GitHub: @adebsa2401
• Twitter: @Adebsa3
• LinkedIn: Ben Sales

(back to top)

🔭 Future Features

• Add navigation to the website
• Be able to make custom research. For now only the default shows displayed at the startup can be browsed
• Add reseravtion on a show item

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

• Microverse

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)