README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 yousRoz-Restaurant

• Javascript capstone project, this project is about building a restaurant web application based on an external API, We selected an API that provides data about a a list of meals then build the webapp around it using API.

• Team members
  • Zuhra Hashimi
  • Bright Kportiklah
  • Omar Farouq

• A link to the Kanban board: https://github.com/ZuhRa-HashiMi/JS_Capastone/projects/1

• A link to the project's GH repository: https://github.com/ZuhRa-HashiMi/JS_Capastone/tree/main

• Sample of pull requests
  • Reviewed by Zuhra : #33
  • Reviewed by Bright: #34
  • Reviewed by Omar : #22

• Presentation videos
  • Presentation by Zuhra : https://drive.google.com/file/d/1qMNesf3U50DoFap9QCNOjEF5N3IWqZIY/view
  • Presentation by Bright :
  • Presentation by Omar : https://drive.google.com/file/d/1KTEBnBc_FmxQYor7V7wyh9TKplLcYYVt/view?usp=share_link

🛠 Built With

Tech Stack

Languages

• HTML
• CSS
• JavaScript

Technologies

• APIs
• Linters
• Webpack

🚀 Live Demo

• You can use this project live by clicking Live Demo

Desktop Display

Mobile Display

(back to top)

💻 Getting Started

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

Prerequisites

• Use git clone to clone the repository using the HTTPS link into your local machine

Setup

• cd into your local repository

Install

• npm install - Installs the necessary dependencies

Usage

• npm run build - Builds development files into production code

Run tests

• npx eslint . - for JS check
• npx stylelint "**/*.{css,scss} - for CSS check

Deployment

• npm start - Starts the development server

(back to top)

👥 Authors

👤 Zuhra Hashimi

• GitHub: @ZuhRa-HashiMi
• Twitter: @ZuhraHashimi4
• LinkedIn: zuhra-hashimi

👤 Omar Farouq

• GitHub: @Ofarouq310
• Twitter: @Ofaouq310
• LinkedIn: @Ofarouq310

👤 Bright Kportiklah

• Github: @BryteLitty(https://github.com/Bryte)
• Twitter: @bryteLitty(https://twitter.come/BryteLitty)
• LinkedIn: Bright Kportiklah(https://www.linkedin.com/in/bright-kportiklah-05512418a/)

(back to top)

🔭 Future Features

• [New styles will be implemented]

• [The functionalities of the second & third page will be implemented]

(back to top)

🤝 Contributing

• Contributions, issues, and feature requests are welcome!

• Feel free to check the issues page.

(back to top)

⭐️ Show your support

• If you like this project, please feel free to give a ⭐.

(back to top)

🙏 Acknowledgments

• All thankfulness to Microverse for equipping us with such skills to utilize in real-world projects and applications.

(back to top)

📝 License

• This project is MIT licensed.

(back to top)