Elijahdre / meal-master-frontend

Meal Master App is a web application for ordering food with user authentication and admin access. Users can select foods by theme, place orders, view their order history, and add or delete items (for admins only). The app includes a form for adding new items and a list of orders with food name, date, and city. Full API documentation is provided.

📗 Table of Contents

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

📖 MEAL-MASTER

Meal-Master is a fullstack web application that is built on rails framework and React that enables a user to create an account, sign-in, order foods of their liking, and/or delete their orders.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Fetch all orders from API endpoint]
• [Fetch all foods from API endpoint]
• [Authenticate users]
• [Add food]
• [Delete food]
• [Place orders]

Preview

🚀 Live Demo

• Live Demo Link

Backend

• Backend repository

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Install Git.
• Install a code editor of your choice.
• Knowledge of javascript,react and Ruby on Rails.
• Github account is required.
• Install nodejs.

Setup

Clone this repository to your desired folder:

  git clone https://github.com/DaveZag/meal-master-frontend.git

Install

Install this project with:

  cd meal-master-frontend # Change directory into project folder
  npm install # Installs project dependencies

Usage

To run the project, execute the following command:

  npm start # for running the project in development mode

  npx stylelint "**/*.{css,scss}" --fix # Stylelint errors auto correct
  npx eslint "**/*.{js,jsx}" --fix # Eslint errors auto correct

Run tests

To run tests, run the following command:

  npm test  # for running the tests

(back to top)

👥 Authors

👤 Dave Zagabe

👤 Kasaija Kenneth

👤 Kaweesi Matia

👤 Olivier Kango

👤 Elijah Odjegba

🔭 Future Features

• [Improvements on UI design]
• [Mobile version]
• [new_feature_3]

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

I would like to acknowledge:

• Microverse for the opportunity to work on this project
• The creative common for the design
• Design from Murat Korkmaz on Behance

❓ FAQ

• How I can run this project?

  • After cloning repository, run npm install to install all dependencies. Then run npm start to run the project.

• How I can run tests?

  • After cloning repository, run npm install to install all dependencies. Then run npm test to run the tests.

📝 License

This project is MIT licensed.

(back to top)