📗 Table of Contents

• 📗 Table of Contents
• 📖MEAL MASTER BACKEND
  • Erd diagram
  • 🛠 Built with
    • Tech stack
    • Key features
  • 🗎 API documentation
  • 🗎 Kanban Board
  • 🚀 Live demo
  • 💻 Getting started
    • Pre requisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 MEAL MASTER BACKEND

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.

Erd diagram

🛠 Built with

Tech stack

Client

• React.js

Server

• Rails.js

Database

• PostgreSQL

Key features

Key features of the application are

• Fetch all orders
• Fetch all foods
• Authenticate users
• Add food
• Delete food
• Place orders
• Delete orders

(back to top)

🗎 API documentation

local API Doc link

Remote API Doc link

Kanban Board

• We are a team of five and used Kanban board to manage our project tasks

• Check here Kanban Board Kanban Board

• Here is the link to kanban board initial state

Meal-Master-Frontend

🚀 Live demo

• Live Demo

(back to top)

💻 Getting started

This project can be used by anyone for any good purpose.

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

Pre requisites

In order to run this project you need:

• Ruby and Rails on you operating system eg. for Windows or Linux
• React.js
• Install nodejs
• PostgreSQL database installed
• Install Git
• Install a code editor of your choice
• Knwoledge of javascript and react
• Github account is required

Setup

Clone this repository to your desired folder:

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

Install

Install this project with:

  cd meal-master-backend # Change directory into project folder
  bundle install # Installs project dependencies

Important steps after installing project to local machine

1. Please run rails db:create and rails db:migrate.
2. Check Ruby version and database.yml file. ( Insert your password if there is required)

Usage

To run the project, execute the following command:

  rails s # for running the project in development mode

Run tests

To run tests, run the following command:

  rubocop -A # for checking and correcting linter errors
  rake rswag # for checking the API documentation

Note: If for some reason you are not able to run the tests, please delete the folowing files:

  config/credentials.yml.enc
  config/master.key

  and run the following commands:
  EDITOR="code --wait" bin/rails credentials:edit

  and then run the tests again

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Dave Zagabe

👤 Kasaija Kenneth

👤 Kaweesi Matia

👤 Olivier Kango

👤 Elijah Odjegba

(back to top)

🔭 Future Features

• Implement Mobile Version
• Add the ability to upload an Image

(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 buy us a drink

(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

(back to top)

❓ FAQ

• Is Rails still relevant?

  • Yes, Rails is still popular among developer

• Is it easy to learn Ruby on Rails

  • It is very easy to learn compared to most of the programming languages

(back to top)

📝 License

This project is MIT licensed.

(back to top)