Skip to content

This project hitting Two API one for getting list of meals and other for user involvement.

License

Notifications You must be signed in to change notification settings

abdallahmalima/PAKTZ_Restaurant

Repository files navigation

Microverse HTML CSS JavaScript Webpack

PAKTZ_Restaurant

This project hitting Two API one for getting list of meals and other for user involvement.

πŸ›  Built With

HTML
CSS
JavaScript
Webpack

Tech Stack

Client
Server

Key Features

  • Query data from API
  • Send data to API
  • Single-Page-Application

πŸš€ Live Demo

πŸš€ Kanban Link

πŸš€ Pull Requests

πŸ’» Getting Started

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

Prerequisites

  • VIsual Studio Code.
  • A Web Browser (preferably Google Chrome)

Setup

  • Clone the GitHub Repository

  • To Get API KEY

  • For MEAL_API_KEY Visit Meal-API-Documentation website for API documentation, find public API KEY

  • For INVOLVEMENT_API_KEY Visit Involvement-API-Documentation website for API documentation, Send a POST request to server Involvement-API, server it will respond with new App ID

  • Create .env file in the root directory,Add below text in your .env file,Remember to replace values after = sign with your API Keys MEAL_API_KEY=123 INVOLVEMENT_API_KEY=kasjdflkasj

  • run this commands in your terminal:

    • npm install
    • npm run build
    • npm start

Usage

After running npm start the website will be opened automatically on your default browser.

Run tests

To run tests, run the following command in your terminal:

  • npm test

Deployment

You can deploy this project using GitHub follow the steps:

  • click on repository setting
  • navigate pages in the setting and click
  • select the branch for deployment and save it
  • navigate to Actions and you will find your website link
  • put /dist/ at the end of link then your website will shown on web-browser

πŸ‘₯ Authors

πŸ‘€ Mujeeb Ur Rahman

πŸ‘€ Abdallah Antony

🀝 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

  • Thanks to the Microverse team for the great curriculum.
  • Thanks to the Code Reviewer(s) for the insightful feedback.
  • A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
  • Hat tip to anyone whose code was used.

πŸ“ License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.