An open API service indexing awesome lists of open source software.

https://github.com/hanasabih/the-meal

The Meal is a website that allows users to check the number of meals and interact by giving a like to their favorite meals and checking for other users' comments, as well as adding their own.
https://github.com/hanasabih/the-meal

babel bootstrap5 javascript jest webpack

Last synced: 12 months ago
JSON representation

The Meal is a website that allows users to check the number of meals and interact by giving a like to their favorite meals and checking for other users' comments, as well as adding their own.

Awesome Lists containing this project

README

          

# the-meal

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 the-meal

**the-meal** is a group capstone project to dynamically build a restaurant website using Javascript, Webpack, a couple of APIs and Jest for testing.
[Project Presentation](https://drive.google.com/file/d/1dD3gdJoclYL2EUmbS6JrvzrtYi-83_12/view?usp=sharing)

### Key Features

- **[Webpack configured]**
- **[Dynamic build]**
- **[API integration]**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://hanasabih.github.io/the-meal/dist)

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps: -[Clone](https://github.com/HanaSabih/the-meal.git/) the repository to your local environment.
-Visit the repository, and click 'Code' to obtain the SSH and Github CLI urls instead.

### Prerequisites

Webpack
Jest

### Setup

Clone this repository to your desired folder:

### Run tests

'$npm run test' in your terminal. Tests will be run on the comments and items counter functions.
'$npm start' to run the webpack live server.

(back to top)

## 👥 Authors

👤 **Hana Sabih**

- GitHub: [@HanaSabih](https://github.com/HanaSabih)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)

👤 **Alwyn Androvelle**

- GitHub: [@Thoth1111](https://github.com/thoth1111)
- Twitter: [@androvelle](https://twitter.com/androvelle)
- LinkedIn: [alwyn-androvelle-simiyu](https://linkedin.com/in/alwyn-androvelle-simiyu/)

(back to top)

## 🔭 Future Features

- [ ] **Animations**
- [ ] **Transitions**
- [ ] **Responsive like icons**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/HanaSabih/the-meal/issues/).

(back to top)

## 🙏 Acknowledgments

We would like to thank Microverse institution for the training relevant to the completion of this project

(back to top)

(back to top)

## 📝 License

This project is [CC](http://creativecommons.org/licenses/by-nc/4.0/) licensed.

(back to top)