belaymit/Capstone-module-2

Capstone-Module-2 is and educational project and is about building web application based on an external API. We selected TVmaze API that provides data about a movies and build the web app around it. Our web app has 3 user interfaces.

Iqbal Belay Diego

📗 Table of Contents

• 📗 Table of Contents
• 📖 Capstone-Module-2
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 🎥 Video Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
    • Issues
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 Capstone-Module-2

Capstone-Module-2 is and educational project and is about building web application based on an external API. We selected TVmaze API that provides data about a movies and build the webapp around it. Our webapp has 3 user interfaces.

🛠 Built With

Tech Stack

Client

• JavaScript

Server

• Express.js

Database

• PostgreSQL

Key Features

• Home Page
• Detail pop up with Comments
• Detail pop up for Reservation

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

🎥 Video Demo

• Here is a video of the project walking you through the website and talking over the main features.

(back to top)

💻 Getting Started

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

Prerequisites

In order to do this project you need:

A knowledge of: HTML5/CSS3 JavaScript webpack linters -> eslint and stylelint APIs ES6 AAA pattern testing git and git-flow project management using Kanban board

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Iqbal-Elham/Capstone-module-2.git

Install

Install this project with:

  cd Capstone-module-2
  npm install
  npm audit fix --force (optional)-> only if there is conflict in node version.

Usage

To run the project, execute the following command:

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

GitHub pages netlify 000webhost

(back to top)

### Issues To create an issues for this project > Go to [issues page](https://github.com/Iqbal-Elham/Capstone-module-2/issues)

👥 Authors

👤 Belay Birhanu G.

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Iqbal Elham

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Diego Gonzalo Cuenca Morocho

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Contacts
• Gallery

(back to top)

🤝 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 please give it a star

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

• We would like to thank Microverse Community

(back to top)

❓ FAQ (OPTIONAL)

• What challenges we faced while developing this web app?

  • extracting a specific item's id when attempting to get more information from a pop-up

• What is the output of this project?

  • We assessed our knowledge of JavaScript, ES6, APIs, Webpack, and AAA pattern testing from this educational project.

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