An open API service indexing awesome lists of open source software.

https://github.com/markokermi/latest_meals_app_cp-project

Latest Meals app displays several different meals offered in local restaurants. User can comment about the mean and can even leave a like if impressed with the meal.
https://github.com/markokermi/latest_meals_app_cp-project

css html5 javascript jest-test webpack

Last synced: 3 months ago
JSON representation

Latest Meals app displays several different meals offered in local restaurants. User can comment about the mean and can even leave a like if impressed with the meal.

Awesome Lists containing this project

README

          



logo

Microverse README Template

# 📗 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)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 [Latest Meal App]

-Latest Meals app displays several different meals offered in local restaurants. User can comment about the mean and can even leave a like if impressed with the meal.

## 🛠 Built With

- HTML
- CSS
- Javascript

## 🚀 VIDEO WALKTHROUGH

- [Walkthrough link](https://drive.google.com/file/d/1htfMwT_eBf42EtfQewOEaoj4mQ-4HOjg/view?usp=share_link)

## 💻 Getting Started

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

1. Clone the Repo or Download the Zip file or `https://github.com/MarkoKermi/javascript_capstone_project.git`
2. cd /leaderboard
3. Open it with the live server

### Prerequisites

In order to run this project you need:

- Git/Github
- HTML and CSS knowledge
- VS code or any other equivalent tool.

### LIVE DEMO

- See it live by clicking [Live Demo Link](https://markokermi.github.io/javascript_capstone_project/dist/)

### Setup

Clone this repository to your desired folder:

### Install

Install this project with:

- to install locally run git clone https://github.com/MarkoKermi/javascript_capstone_project.git
- open the cloned directory with VSCode
- Install live server extension for VSCode
- Right click on the index.html and select open with live servers
### Run tests

To run tests, run the following command:

For tracking linter errors locally you need to follow these steps:

After cloning the project you need to run these commands

`npm install` `This command will download all the dependancies of the project`

For tracking linter errors in HTML files run:

`npx hint .`

For tracking linter errors in CSS or SASS files run:

`npx stylelint "**/*.{css,scss}`

And For tracking linter errors in JavaScript files run:

`npx eslint .`

### Usage

- Feel free to use this project.

## 👥 Author

> This is a collaborative project.

👤 **Towett Sammy**

- GitHub: [@sam](https://github.com/Sammy3000)
- Twitter: [@towettsam](https://twitter.com/sammy15375658)
- LinkedIn: [@towettSammy](https://www.linkedin.com/in/towett-sammy-43476024a/)

👤 **Marko Kermi**

- GitHub: [@MarkoKerm](https://github.com/MarkoKermi)
- Twitter: [@MarkoKermi](https://twitter.com/MarkoKerm)
- LinkedIn: [@MarkoKermichiev](https://www.linkedin.com/in/marko-kermichiev-78b1bb110/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## ⭐️ Show your support

Give a ⭐️ if you like this project!

## 🙏 Acknowledgments

- I would like to thank Microverse for granting me the knowledge to do this.
- Thanks to My coding Partner.
- Thanks to My Morning-session-group and Standup-team Partners.
- Thanks to Code Reviewers

## 🔭 Future Features

- [ Loaders] **[I will add loaders as we await data from API]**

## 📝 License

This project is [MIT](./LICENSE) licensed.