CHOPS-AND-HOPS

📗 Table of Contents

Click to view contents

1. 📖 About the Project
   • 📹 Video
   • 🛠 Built With
     • Tech Stack
     • Key Features
   • 🚀 Live Demo
2. 💻 Getting Started
   • Setup
   • Prerequisites
   • Install
   • Usage
   • Run tests
   • Deployment
3. 👥 Authors
4. 🔭 Future Features
5. 🤝 Contributing
6. ⭐️ Show your support
7. 🙏 Acknowledgements
8. ❓ FAQ
9. 📝 License

📖 CHOPS AND HOPS

CHOPS AND HOPS is an elegant website that retrieves savory dishes from a restaurant API and presents them to the user. It also enables users to comment and like the dishes.

🛠 Built With

Tech Stack

• Javascript
• WebPack
• AAA test Pattern(Jest)

Client

• JavaScript
• WebPack
• Jest

Key Features

Using this website you can:

• Add comments on the dish.
• Like the Dish.

(back to top)

🚀 Live Demo

Click Here for live Version!

(back to top)

💻 Getting Started

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

Prerequisites

• NPM package manager

Setup

Github

• Enter this url: https://github.com/developerwaleed/CHOPS-AND-HOPS in your web browser.
• Once opened navigate to the top left level of the project a green code download button will be visible on the righthand side.
• Select the download Zip option from drop-down menu.
• Once the download is complete you will be able to access my project locally.

Local (Terminal)

  git clone https://github.com/developerwaleed/CHOPS-AND-HOPS.git
  cd CHOPS-AND-HOPS

Install

Install dependencies and gems in this project with:

  cd CHOPS-AND-HOPS
  npm install

Usage

To run the project, execute the following command:

• Run npm run start or npm start to start a development server.

Run tests

To run tests, run the following command:

npm run test

Deployment

You can deploy this project using:

• Github Pages
• Netlify

(back to top)

👥 Authors

| 👤 Name | Github | Twitter | LinkedIn | |——|——–|———|———-| |Waleed Amjad|@caasperr|@developerwaleed|@developerwaleed|

(back to top)

🔭 Future Features

• Currently none.

(back to top)

🤝 Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue, feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project. Don’t forget to give it a ⭐️

(back to top)

🙏 Acknowledgments

• A big thanks to @microverseinc for the project idea, guidance and inspiration.

(back to top)

❓ FAQ

• What inspired me to create this project?

  • The inspiration for this project came from microverse – a software development bootcamp where you work with teammates remotely on different projects.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

This site is open source. Improve this page.