https://github.com/developerwaleed/chops-and-hops
This Chops and Hops is a web application that fetches the data from API and show it to the user.
https://github.com/developerwaleed/chops-and-hops
css css3 html javascript webpack5
Last synced: 12 months ago
JSON representation
This Chops and Hops is a web application that fetches the data from API and show it to the user.
- Host: GitHub
- URL: https://github.com/developerwaleed/chops-and-hops
- Owner: developerwaleed
- License: other
- Created: 2022-06-20T12:16:27.000Z (almost 4 years ago)
- Default Branch: dev
- Last Pushed: 2022-12-31T21:04:37.000Z (over 3 years ago)
- Last Synced: 2024-10-02T12:41:16.491Z (over 1 year ago)
- Topics: css, css3, html, javascript, webpack5
- Language: JavaScript
- Homepage:
- Size: 3.27 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
Click to view contents
-
📖 About the Project
-
💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ
- 📝 License
**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.
- Javascript
- WebPack
- AAA test Pattern(Jest)
Client
Using this website you can:
- Add comments on the dish.
- Like the Dish.
## 🚀 Live Demo
[Click Here for live Version!](https://gregarious-melba-786499.netlify.app/)
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](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)
```sh
git clone https://github.com/developerwaleed/CHOPS-AND-HOPS.git
cd CHOPS-AND-HOPS
```
### Install
Install dependencies and gems in this project with:
```sh
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
## 👥 Authors
| 👤 Name | Github | Twitter | LinkedIn |
|------|--------|---------|----------|
|Waleed Amjad|[@caasperr](https://github.com/developerwaleed)|[@developerwaleed](https://twitter.com/developerwaleed)|[@developerwaleed](https://www.linkedin.com/in/developerwaleed/)|
- Currently none.
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](../../issues/).
If you like this project. Don't forget to give it a ⭐️
- A big thanks to [@microverseinc](https://github.com/microverseinc) for the project idea, guidance and inspiration.
- **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.
This project is [MIT](./LICENSE) licensed.