PRIME SHOWS HD

Microverse Second Capstone Project

This educational project is to build our own web application based on an external API. We selected an API that provides data about a topic that we like and built the web app around it. The web app will have 2 user interfaces.

Learning Objectives 🔖

• Use JavaScript to make websites dynamic and build basic single page apps.
• Use ES6 syntax.
• Use ES6 modules.
• Use callbacks and promises.
• Use webpack.
• Apply JavaScript best practices and language style guides in code.
• Use AAA pattern for unit tests.
• Write units tests for a JavaScript app.
• Follow Gitflow.
• Solve simple git conflicts.
• Send and receive data from an API.
• Use API documentation.
• Understand and use JSON.
• Make JavaScript code synchronous.
• Perform a code review for a team member.

Project Documentation 📄

• Here is the presentation video link👈

Built With 🛠️

• Languages: HTML, Sass and JavaScript
• Linters: Lighthouse, Webhint, Stylelint and ESLint
• Module Bundler: Webpack
• Module Bundler Loaders: Style, CSS and Sass
• Module Bundler Plugins: HtmlWebpackPlugin, FaviconWebpackPlugin, MiniCssExtractPlugin and CssMinimizer Plugin
• APIs: TVmaze API and Involvement API
• Code Editor: VS Code

Website Mockup 📱 💻 🖥️

Screenshots 📸

Screenshots can be found in the repository.

Live Demo 🔗

Check the live demo here👈

Getting Started

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

Prerequisites

• A web browser like Google Chrome.
• A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Node.js and npm for package installation.

$ node --version && npm --version

Setup

Clone the repository using the GitHub link provided below.

Install

In the terminal, go to your file directory and run this command.

$ git clone git@github.com:mavericks-db/capstone02.git

Usage

Kindly modify the files as needed.

Run tests

To check for linters, use the files provided by Microverse. A GitHub action is also set to run during pull request.

$ npm install

Deployment

This app is deployed in the GitHub Pages for easy viewing upon merged on the main branch. Please find the link in the Live Demo section.

Authors

👤 Brian Nyachae

• GitHub: Brian
• Twitter: @briannyachae9
• LinkedIn: @brian-nyachae

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse
• Code Reviewers
• Coding Partners

📝 License

This project is MIT licensed.