📗 Table of Contents

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

📖 [Restaurant]

[Our Restaurant] is a website for a restaurant. With this app, customers can see the meals, pictures, ingredients and even the cooking process, they can like and comment on meals. All data is preserved thanks to Involvement API. This website is build by using JavaScript, Webpack and ES6.

🛠 Built With

Tech Stack

• HTML
• CSS
• Javascript

Key Features

• [display the meals]
• [add like]
• [add comment]
• [display the likes and comments]

(back to top)

🚀 Live Demo

• Live Demo

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 npm install

Setup

Clone this repository to your desired folder:

  git clone https://github.com/AbuTalha3/csp-js-module2.git

  cd javascript-capstone

Install

Install this project with:

 npm install

Usage

To run the project, execute the following command:

  npm run build

Run tests

To run tests on linters, run the following command:

  npx stylelint "**/*.{css,scss}"
  npx hint .
  npx eslint .

To run test coverages, run the following command:

  npm test

Deployment

You can deploy this project using:

   npm start

(back to top)

👥 Authors

👤 Abu Talha

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Siddhartha Ghosh

• GitHub: @siddghosh108
• Twitter: @siddharthaghos9
• LinkedIn: @siddhartha-ghosh-65902718

(back to top)

🔭 Future Features

• [add animation]
• [contact page]
• [reservation page]

(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 our project please give a ⭐️. If you have any suggestions or questions, you can contact us with Abu Talha or Siddhartha Ghosh

🙏 Acknowledgments

I would like to thank my coding partner for sharing their knowledge and experience.

📝 License

This project is LICENSE licensed.

(back to top)