My Meals

📗 Table of Contents

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

📖 My Meals

My Meals is about building own web application based on an external API. Data is preserved thanks to the external API service.

👁‍🗨 Preview

🛠 Built With

Tech Stack

Languages

• HTML5 / CSS / JavaScript

IDE

• Visual Studio Code

Hosting

• GitHub

Key Features

• Connect to the API
• "Refresh" and "Submit" buttons
• Async & await operations

🚀 Live Demo

• Live Demo Link

💻 Getting Started

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

• Get a copy of the project
• Come into the project directory
• Open the project using code editor of your choice
• Open your prefered browser

Prerequisites

In order to run this project:

• You need a GitHub account.
• You need to have a Git client installed on your computer.
• You need to have a copy of the HTML CSS website codebase on your computer.
• You need a code Editor of your choice.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/SergSkol/myMeals.git

Install

Install all the dependencys required for the website, by using the command below

  cd myMeals
  npm install

Usage

For making changes to the project you should clone the project.

Run tests

If you want to work with Chrome Developer Tools, simply run the HTML document in Google Chrome and right-click the HTML element you want to inspect. Click on "Inspect" and you will have the tools to run, analyze, and even debug the code.

Deployment

If you like to deploy the website to the github pages please follow the link here.

👥 Authors

👤 Odai Alazzeh

• GitHub: @odaialazzeh
• Twitter: @odaialazzeh4
• LinkedIn: LinkedIn

👤 Sergiy Shkolnik

• GitHub: @SergSkol
• Twitter: @sps676
• LinkedIn: LinkedIn

🔭 Future Features

• Advanced styles
• Testing with Jest
• Responsive design in mobile version

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

Give a ⭐️ if you like this project!

🙏 Acknowledgments

I would like to thank:

• Microverse
• API service

📝 License

This project is MIT licensed.