Flame-cafe

📗 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
• 📝 License

📖 [Flame Cafe]

The Flame-cafe website displays Meals form an external API. It also allows visitors to like and make a comment. All data is preserved thanks to the external Meals DB API service and involvement API .

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JS
• Webpack

Server

• External API

Database

• External API

Key Features

• Dynamic single page app with javascript
• Use of webpack
• Perfect Design
• Live interaction through likes and comments
• Pagination
• Search option
• Fully responsive - Mobile friendly

(back to top)

🚀 Live Demo Live

🚀 Video Recording Walkthrough Visit Video Link

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• A PC running any operating system like Windows, Linux, or MacOS
• An Internet connection
• Git installed
• Webpack installed
• Knowledge of some basic Git commands

Setup

• Link your PC to GitHub
• Clone this repository to your desired folder:

Clone this repository to your desired folder:

git clone https://github.com/shayan1234554321/flame-cafe

• Open the file in your code editor

Install

• Setup JavaScript + CSS + HTML linter

Run the following codes in your project folder in your IDE:

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

• webpack

npm install --save-dev webpack

npm install --save-dev webpack-cli

• project dependencies

npm install

Usage

To run the project, execute the following command:

Start the server

npm run start

Run tests

To run Stylelint and ESLint tests, run the following commands respectively:

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

npx eslint .

Deployment

To deploy this project run

npm run deploy

(back to top)

👥 Authors

👤 Shayan

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Muhammed

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Adding 'More' options]
• [Working on comment popup styling]

(back to top)

🤝 Contributing

You can contribute to this project by writing an issue here

(back to top)

⭐️ Show your support

If you like this project please leave a ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and youtube for help

(back to top)

📝 License

This project is MIT licensed.

(back to top)