sammy3000 / javascript-capstone-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.

Microverse README Template

📗 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
• ❓ FAQ (OPTIONAL)
• 📝 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

💻 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

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
• Twitter: @towettsam
• LinkedIn: @towettSammy

👤 Marko Kermi

• GitHub: @MarkoKerm
• Twitter: @MarkoKermi
• LinkedIn: @MarkoKermichiev

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ 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 licensed.