Code Monkey home page Code Monkey logo

meal-app's Introduction

πŸ“— Table of Contents

πŸ“— Table of Contents

πŸ“– Meal App

Meal App is web application that helps you decide your next meal. Select a meal to see how its prepared, or post a comment on how delicious it is. Don't forget to like 🧑 your favorites

image

πŸ›  Built With

Tech Stack

Client

Key Features

  • Fetches and displays meal information under different categories from the mealdb API
  • Fetches and displays likes and comments for each meal using the involement API
  • Displays loading screens to the user during fetch
  • Displays additional meal information in a modal popup
  • Allows users to like meals
  • Allows users to comment on meals
  • Allows users to search for meals
  • Responsive design which adapts to most screen sizes

(back to top)

πŸš€ Live Demo

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

 git
 npm
 node
 Your favorite text editor

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Shisui6/meal-app.git

Install

Install this project with:

  cd meal-app
  npm install

Usage

To run the project, execute the following command:

  npm run build - Builds development files into production code
  npm start - Starts the development server

Run tests

To run tests, run the following command:

  npm test - Launches the test runner in the interactive   watch mode

Deployment

You can deploy this project using:

  npm run deploy - Deploys using gh-pages

API Instructions

Instructions to setup Involvement API key are as follows:

- Create a new app on your command line using ` curl -X POST https://us-central1-involvement-api.cloudfunctions.net/capstoneApi/apps/ `
- Add the returned API key to a `.env` file in your root directory using `API_KEY=returnedApiKey`
- Note: make sure to replace `returnedApiKey` with your API key

(back to top)

πŸ‘₯ Authors

πŸ‘€ Shisui

πŸ‘€ Ahmed

(back to top)

πŸ”­ Future Features

  • Create user profiles
  • Save favorite meals for users on their dashboard

(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 please leave a star🀩

(back to top)

πŸ™ Acknowledgments

(back to top)

πŸ“ License

This project is MIT licensed.

(back to top)

meal-app's People

Contributors

shisui6 avatar boo-shehab avatar

Stargazers

Ebrahim Suhail Al-Yousefi  avatar Moses Wamae avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.