JavaScript-Capstone

📖 JavaScript Capstone Project - Meals App

📗 Table of Contents

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

📖 JavaScript Capstone Project meals app

JavaScript Capstone Project meals app is a progressive web app that displays meals fetched from an API, and also displays comments about the meal submitted by different viewers. It also allows you like a certain element, thanks to the additional Capstone-API provided by microverse.

🛠 Built With

• Node NPM manager
• Front-end dev languages
• Served with webpack
• Deployed with gh-pages
• Tested with Jest

Tech Stack

Client

• HTML
• Javascript & DOM
• ES6 modules
• Webpack
• API
• Jest

Key Features

• use gitflow
• connect to the Meals API
• sends, receives and deisplay data from these two APIs.
  • Meals API
  • Interactive API

(back to top)

💻 Getting Started

🚀 Live Demo

• Coming Soon

🚀 Zoom Video (explanation)

Author’s Explanation

(back to top)

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

Prerequisites

Run the following commands, in order to run this project: - npm install - For tests npm i jest-environment-jsdom --save-dev && npm test

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:yordinia/JavaScript-Capstone.git

Install

Install this project with:

  cd JavaScript-Capstone
  npm install

Usage

To use this project - Run npm start or npm run build - Open index.html from /dist with your prefered browser

(back to top)

👥 Author

👤 Misal Azeem

• GitHub: @misalazeem
• Twitter: @misal_azeem
• LinkedIn:@misal-94755a82

👤 Yordanos Temesgen

• GitHub: @yordinia
• Twitter: @yordinaM
• LinkedIn: @yordanos-temesgen-941727233

(back to top)

🔭 Future Features

• Set up the resevations section
• Better UI, speed and interactivity

(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 give a star ⭐️ to this project

(back to top)

🙏 Acknowledgments

I would like to thank Microverse team, coding partners for the amazing collobrating project

(back to top)

📝 License

This project is MIT licensed.

(back to top)