ali-0111/js-capstone-group-project

A group project for javascript capstone

Restaraunt Meal (JS Capstone Group Project)

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Restaraunt Meal (JS Capstone Group Project)

Restaraunt Meal (JS Capstone Group Project) is a JavaScript capstone project about building a web application based on an external API. We selected the Meals API that provides data about meals we like and then built the webapp around it. The webapp has 3 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 it or reserve it for a period of time.

🛠 Built With

Tech Stack

Front-End

• HTML

• CSS

• JavaScript

Back-End APIS

• Meals API

• Involvement API

Key Features

• This website is created completely using front and backend technologies
• This website uses 2 different APIs to post and fetch data
• Display meals grabbed from the Meals API
• Display likes each meal receives
• Counter displayed on main page showing the amount of meals viewable
• Comments popup that allows you to post to and view comments from the Involvement API
• Reservations popup that allows you to reserve and view reservations from the Involvement API
• Linters: Lighthouse, Webhint, Stylelint, and Eslint
• Asyncronous ES6 Javascript
• Webpack
• Jest Testing

(back to top)

🚀 Live Demo

• Live Demo Link

• Below is a link to our video presentation of the project.

  • Our video presentation

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need to:

• Have npm installed in your project: curl -qL https://www.npmjs.com/install.sh | sh

Setup

Clone this repository to your desired folder:

git clone git remote add origin https://github.com/ClintonYounge/JS-Capstone-Group-Project

or

git clone git remote add origin https://github.com/ClintonYounge/JS-Capstone-Group-Project <-- Only if you have SSH keys configured on your GitHub account.

or

Utilizing Github Desktop. A simple interface, thats powerful enough to simplify this process. https://desktop.github.com/

Install

Run the npm install command in your console to install all necessary dependencies.

Run tests

To run tests, run the following command:

Run the npx jest command in your console to run the tests.

👥 Authors

👤 Clinton Younge

• GitHub: @ClintonYounge
• Linkedin: @clinton-younge
• Twitter: @YoungeCjay

👤 Sameed Mohsin

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

👤 Qurban Ali

• GitHub: @safari
• Twitter: @safari
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

-[Responsive layout for most devices]

• [Improved User Interface]

(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 feel free to leave a star to show your support.

(back to top)

🙏 Acknowledgments

We would like to give thanks to Microverse for equipping us will all the necessary information needed to complete this project. As well as for providing an environment that makes us strive to grow as developers.

(back to top)

📝 License

This project is MIT licensed.

(back to top)