📗 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 (OPTIONAL)
• 📝 License

📖 JavaScript Group Project

The JavaScript capstone project is about building my own web application based on an external API. The webapp has 2 user interfaces:

• A home page showing a list of items that you can "like."
• A popup window with more data about an item that you can use to comment on.

Built With

• HTML, CSS, JavaScript
• VSCode and GitHub
• Webpack
• TVMAZE API
• Involvement API

(back to top)

Tech Stack

Client

• JavaScript

• Html

• CSS

Server

• Involvement API
• MealsDB API

Database

• N/A

Key Features

• [Git Flow]
• [Good HTML, CSS and JS practices]
• [ES6, modules]

(back to top)

Live Demo

Live Demo Link

💻 Getting Started

Clone this repository to get started with the project, make sure to configure linters by following the instructions in the Linters README file

Prerequisites

In order to run this project you need:

• A working computer.
• Connection to internet.

Setup

• Clone the folder to your local machine.
• Open a local copy of the project in your code editor.
• Open the index.html file from the /dist folder in your browser.
• Run npm install to install all dev dependencies for Linters, Webpack & Babel.

(back to top)

Usage

• To run the project, execute the following command:

  • npm run start in your terminal.

• To run test functions, execute the following command:

  • npm test in your terminal.

(back to top)

Run tests

• After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.
• For stylelint errors run:sudo npx stylelint "*/.{css,scss}" --fix for automatic fix.

(back to top)

👥 Authors

👤 Ashmal Zahra

• GitHub: @ashmalzahrae
• Twitter: @AshmalZahraa
• LinkedIn: ashmal-zahra

👤 Jesus Molina

• GitHub: @Sparktan24
• Twitter: @Sparktan1
• LinkedIn: Jesus Molina

(back to top)

🔭 Future Features

• Cool styles will be added in the future

(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

I would like to thank Microverse for the information provided to build this project.

(back to top)

❓ FAQ (OPTIONAL)

• Can I use the project for any purpose?

  • Yes, you can.

• Is the information saved in any database?

  • No, all data is saved in Local Storage.

(back to top)

📝 License

This project is MIT licensed.

(back to top)