JS-Capstone-Project (Meals Lover)

This project is build around the MealDB API using HTML5,SCSS and JavaScript. You can view various types of Dishes & Meals and you can also get all the info about them. Moreover, you can interact with the meals list by giving them a like or by adding some comments about them.

Built With ⚙️

• Major languages: HTML, CSS, & JavaScript.
• Frameworks: No-Frameworks.
• Linters: Lighthouse, Webhint, Stylelint and ESLint.
• Technologies used: NPM, Webpack, & Jest Library.
• Tools: Git, Gitflow, GitHub, VS Code, & Chrome Browser.

Live Demo (Deployed on GitHub-Pages with SSL)

Live Demo Link

Video Demo (Using Loom)

Meals Lover Video Demo

Getting Started

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

Prerequisites

• Basic Knowledge of HTML, CSS, & JavaScript.
• Basic knowledge of ES6 syntax.
• Basic knowledge of Git & GitHub.
• Basic knowledge of Linters.
• Basic knowledge of Webpack.
• Basic knowledge of Jest unit-testing library.
• Basic knowledge of VS Code or any other code-editors.

Setup

• Create a new Microverse folder and move into it.
• Open the Command Prompt (CMD) in the current directory (Microverse Folder).
• Run the following command:

$ git clone https://github.com/ZikaZaki/JS-Capstone-Project.git

• Once finished you should see a new folder called JS-Capstone-Project in your current directory.
• Start customizing the project so it fits your personal preferences and needs.
• Enjoy your new professional JS-Capstone-Project application!

Install Dependencies

To check for linters, use the files provided by Microverse. A GitHub action is also set to run during pull request.

$ npm install

Run tests

We used the Jest library for testing the project.

$ npm test

Authors

👤 Zakariya Al-Khamisi (ZikaZaki)

• GitHub: ZikaZaki
• Twitter: Zakariya Al-Khamisi
• LinkedIn: Zakariya Al-Khamisi

👤 Bantealem Geto (Bantealem Geto)

• GitHub: Bantealem
• Twitter: Bantealem
• LinkedIn: Bantealem

Show your support

Give a ⭐️ if you like this project!

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Acknowledgments

• Microverse
• Code Reviewers & Coding Partners
• Hat tip to anyone whose code was used
• Inspiration
• etc

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.