aimalamiri / JavaScript-Group-Capstone-Project

The Meal Time website is our JavaScript project. It is about foods which is designed with Tailwind CSS based on two external APIs.

Meal Time restaurant website

The Meal Time website is our JavaScript capstone project. It is about building our web application based on two external APIs. We selected the Free Meal API by TheMealDB which provides data for meals to build the web app around it. We also used the Involvement API by Microverse to record likes and comments.

The web app has two user interfaces since we are a team of two:

• A home page showing a list of items that you can "like."
• A popup window with more data about an item that you can use to comment on.

In the future, we could add another interface to create reservations for a table at the restaurant.

You may read here the document with all the requirements for the project document.

Built With

• HTML 5
• SCSS 3
• Javascript ES6
• Webpack
• Jest (for testing)

Live Demo

• Live Demo Link

• Video presentation

Getting Started

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

Prerequisites

Open your terminal and navigate to the folder you would like to save the project.

Setup

Type these commands into the terminal:

• git clone https://github.com/aimalamiri/JavaScript-Group-Capstone-Project.git
• cd JavaScript-Group-Capstone-Project

You will need a .env file before you install and run the project. There is included an example file .env.example

• cp .env.example .env (if you are using Linux or macOS)
• If you work on Windows, you can use this command in Git Bash.

Install

Type this command into the terminal:

• npm install

Build

Type these commands into the terminal:

• npm run build
• Open dist/index.html in your web browser.

Run webpack dev server

Type these commands into the terminal:

• npm run start
• Your web browser will open on localhost:8080

Run tests

Type this command into the terminal:

• npm run test

Deployment

• npm run deploy

Authors

👤 Aimal Amiri

• GitHub: @aimalamiri
• Twitter: @meaimal
• LinkedIn: Aimal Amiri

👤 Roberto A. Baños Alvarez

• GitHub: @rbanos-mv
• Twitter: @RobertoBanosMV
• LinkedIn: Roberto A Baños Alvarez

🤝 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

• Free Meal API by TheMealDB
• Involvement API by Microverse
• Logo based on Pack de plantillas de logotipos de catering plano vector gratuito creado por freepik - www.freepik.es

📝 License

This project is MIT licensed.