Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lukman155/rosto

A Recipe book for all sorts of meat.
https://github.com/lukman155/rosto

Last synced: 21 days ago
JSON representation

A Recipe book for all sorts of meat.

Awesome Lists containing this project

README 

        



# 📗 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)



# 📖 The Meal 



> In this project, a website for Meals is being build. The external API used for showing Meals and its details is [MealsDB API](https://www.themealdb.com/api.php). The webapp have 2 user interfaces.



- A home page showing a list of meals items that you can "like."

- A popup window with more data about the meal that you can use to comment on it.



## 🛠 Built With 

- HTML

- CSS

- Javascript

- Webpack

- APIs

- Jest



### Tech Stack 



  Webpack

  



  Jest

  



### Key Features 



- **Develop webapp around an API**

- **Conduct test to ensure all edge cases are covered**

- **Create web page using given wireframe**

- **Users can filter amount of movies displayed**



(back to top)



## 🚀 Live Demo 



- [Live Demo Link](https://lukman155.github.io/Rosto/dist/)



## 🚀 Project Details 



- [Kanban Board](https://github.com/lukman155/Rosto/projects/1)



- Team      

        - [Ahmed Mohsen](https://github.com/AhmedMohsen600)

        - [Lukman](https://github.com/lukman155)



     

## 🚀 Pull Request



[Lukman](https://github.com/lukman155/Rosto/pull/29)



[Ahmed](https://github.com/lukman155/Rosto/pull/25)



## 💻 Getting Started 



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



## Clone Git Repository



-Reach to following Github URL:

```

https://github.com/lukman155/Rosto.git



```



-Copy the URL.



-In Visual Studio Code "Terminal" change the current working directory to the location where you want the cloned directory.



-Type git clone in the terminal, paste the URL you copied earlier, and press "enter" to create your local clone.



```

$ git clone https://github.com/lukman155/Rosto.git

```



# Install Dependencies(with following Command)



- npm install



# Build webpack 

- run command

```

npm run build

```



## Start server

```

npm start

```



### Prerequisites 



In order to run this project you need:



- [x] Basic Knowledge of **HTML**, **CSS**, & **JavaScript**.

- [x] Basic knowledge of **ES6** syntax.

- [x] Basic knowledge of **Git**, **GitHub** &**Gitflow**.

- [x] Basic knowledge of **Linters**.

- [x] Basic knowledge of **Webpack**.

- [x] Basic knowledge of **Jest** unit-testing library.

- [x] Basic knowledge of **VS Code** or any other code-editors.



### Setup



Clone this repository to your desired folder:



    _cd PATH_

    

    _git clone https://github.com/lukman155/Rosto.git

   

   _cd Rosto

   

   _npm install_

      

   _npm run build_

   

   _npm start_



### Install



Install this project with:



```sh

  npm install

```



### Usage



To run the project, execute the following command:



```sh

  npm start

```



### Run tests



To run tests, run the following command:



```sh

  npm test

```



### Deployment 



You can deploy this project using:

```sh

  npm start

```



(back to top)



## 👥 Authors 



👤 **Ahmed Mohsen**



- GitHub: [@Ahmed Mohsen](https://github.com/AhmedMohsen600)

- LinkedIn: [@Ahmed Mohsen](https://www.linkedin.com/in/ahmed-mohsen-bb75b2194/)



👤 **Lukman**



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

- LinkedIn: [@Lukman](https://github.com/lukman155)



(back to top)



## 🔭 Future Features 



- [ ] **Implement additional home pages, one page per category of movies**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



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



(back to top)



## ⭐️ Show your support 



Give a ⭐️ if you like this project!



(back to top)



## 🙏 Acknowledgments 



- Thanks to [Microverse](https://www.microverse.org/) for giving this opportunity to learn ...

- Code Reviewers & Coding Partners.

- Hat tip to anyone whose code was used.



(back to top)



## ❓ FAQ 



- **How to generate a new key for the API?**



 - Open VScode and generate a key by using the following command

```

curl -X POST https://us-central1-involvement-api.cloudfunctions.net/capstoneApi/apps/

```



(back to top)



## 📝 License 



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



(back to top)