Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/topeogunleye/recipe-app

A meal finder app that pulls from TheMealDB API to allow users to search for, view recipes, and comment on recipes. Built with JavaScript and Tailwind CSS
https://github.com/topeogunleye/recipe-app

babel css3 eslint html5 javascript stylelint webhint webpack

Last synced: 16 days ago
JSON representation

A meal finder app that pulls from TheMealDB API to allow users to search for, view recipes, and comment on recipes. Built with JavaScript and Tailwind CSS

Awesome Lists containing this project

README

        

logo

Microverse README Template

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [recipe-app]

**[recipe-app]** is a meal finder app that pulls from TheMealDB API to allow users to search for, view recipes, and comment on recipes.

## 🛠 Built With

### Tech Stack

Client

### Key Features

- **[Fetch_API]**
- **[Modals]**
- **[Pagination]**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://recipeappmicroverse.netlify.app/)

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

- Create React App

```sh
npm install webpack
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:topeogunleye/recipe-app.git
```

### Install

Install this project with:

- Install Node Modules

```sh
npm install
```

### Usage

To run the project, execute the following command:

- Start the development server

```sh
npm start
```

### Run tests

To run tests, run the following command:

- Test the items Counter and Comments Counter function

```sh
npm test

### Deployment

You can deploy this project using:

```sh
npm run deploy
```

(back to top)

## 👥 Authors

👤 **Temitope Ogunleye**

- GitHub: [@topeogunleye](https://github.com/topeogunleye)
- Twitter: [@tope_leye](https://twitter.com/tope_leye)
- LinkedIn: [ogunleye](https://linkedin.com/in/ogunleye)

👤 **Gbenga Emmanuel**

- GitHub: [@gbengacode](https://github.com/gbengacode)

(back to top)

## 🔭 Future Features

- [ ] **[animations]**
- [ ] **[deployment]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/topeogunleye/recipe-app/issues).

(back to top)

## ⭐️ Show your support

If you like this project, kindly star it

(back to top)

## 🙏 Acknowledgments

I would like to thank the creators of [yummly](https://www.yummly.com/)

(back to top)

## ❓ FAQ

- **[What inspired you to build this website]**

- [I learnt how to build a recipe website from Brad traversy's 20 Web Projects With Vanilla JavaScript Course ]

- **[What is your favorite food]**

- [Beans and Potatoes]

(back to top)

## 📝 License

This project is [MIT](./MIT.md) licensed.