https://github.com/adnanolarmmi/foody
A responsive and optimized restaurant web app that displays food items, interactive likes and comments for each particular food items.
https://github.com/adnanolarmmi/foody
api-rest css html javascript
Last synced: over 1 year ago
JSON representation
A responsive and optimized restaurant web app that displays food items, interactive likes and comments for each particular food items.
- Host: GitHub
- URL: https://github.com/adnanolarmmi/foody
- Owner: AdnanOlarmmi
- License: other
- Created: 2022-10-17T08:51:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T13:46:56.000Z (over 3 years ago)
- Last Synced: 2025-04-13T21:09:46.196Z (over 1 year ago)
- Topics: api-rest, css, html, javascript
- Language: JavaScript
- Homepage:
- Size: 19.6 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👤 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
**Foody** is a responsive and optimized restaurant web app that displays food items, interactive likes and comments for each particular food items.
.
Client
- **Responsive Design.**
- **Pixel Perfect design.**
- **API Call.**
- [Here is the link to the live experience](https://adnanolarmmi.github.io/Foody/).
> | | Mobile version | Desktop version | |
> | --- | ----------------------------------- | ------------------------------------ | --- |
> | |  |  |
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- A web browser to view output e.g [Google Chrome](https://www.google.com/chrome/).
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- `node` should be installed in your local machine, [node website](https://nodejs.org/en/download/).
- Install the `npm` package manager use this [to install both node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
### Setup
Clone this repository to your desired folder or download the Zip folder:
```
git clone https://github.com/AdnanOlarmmi/Foody.git
```
- Navigate to the location of the folder in your machine:
**``you@your-Pc-name:~$ cd Foody``**
### Install
To install all dependencies, run:
```
npm install
```
### Usage
To run the project, follow these instructions:
- After Cloning this repo to your local machine.
- To get it running on your default browser and local host, run:
```
npm start
```
### Run tests
To run tests, run the following command:
- Track HTML linter errors run:
```
npx hint .
```
- Track CSS linter errors run:
```
npx stylelint "**/*.{css,scss}"
```
- Track JavaScript linter errors run:
```
npx eslint .
```
You can deploy this project using: GitHub Pages,
- I used GitHub Pages to deploy my website.
- For more information about publishing sources, see "[About GitHub pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites)".
👤 **Is-haq, Adnan Olamilekan**
- GitHub: [@AdnanOlarmmi](https://github.com/adnanolarmmi)
- Twitter: [@AdnanIshaqOla](https://twitter.com/AdnanIshaqOla)
- LinkedIn: [Adnan (Olamilekan) Is-haq](https://linkedin.com/in/adnan-is-haq-olamilekan)
👤 **Justice Bajeri**
- GitHub: [Link to Github Profile](https://github.com/Strangeal)
- Twitter: [Link to Twitter Profile](https://twitter.com/Str_angeal)
- LinkedIn: [Link to LinkedIn Profile](https://www.linkedin.com/in/justice-bajeri-0b7211243/)
- [ ] **Implement button to switch sort type (ascending or descending).**
- [ ] **Implement search food feature.**
- [ ] **Add different pages for different food types.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project and how I managed to build it!
- The original design ideal from Microverse💕.
- Project from [Microverse](https://bit.ly/MicroverseTN) JavaScript module.
- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedbacks.
- 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.
- **Can I fork and reuse the repository**
- Yes please, feel free.
- **Can I improve the repository, and my changes will be accepted if they are good?**
- Yes please, nice ideas are welcome, please.
This project is [MIT](./LICENSE) licensed.