• 📖 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
• ❓ FAQ (OPTIONAL)
• 📝 License

Food App is a Ruby on Rails application that keeps track of all your food and recipes. The app allows a user to add foods and the different recipes of the foods. The recipes can either be private or public. Public recipes can be see by anyone while private recipes are only seen by the owner. Only the owner can delete either a food or a reipe. The app also generates a shopping list based on what the foods required to make the recipe.

Describe between 1-3 key features of the application.

• Create, show or delete a food
• Create, display or delete a food recipe
• Display a shopping list

(back to top)

Describe how a new developer could make use of your project.

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

In order to run this project you need:

• Ruby and rails installed
• PostgreSQL server installed
• Visual Studio Code

Clone this repository to your desired folder:

  git clone https://github.com/inspecta/food-app.git

Install this project with:

  cd food-app

Install the required gems

  bundle install

To run the project, execute the following command:

  rails server

To run tests, run the following command:

  gem install rspec
  rspec spec

(back to top)

Mention all of the collaborators of this project.

👤 Author1

• GitHub: @inspecta
• Twitter: @djmulinde
• LinkedIn: LinkedIn

👤 Author2

• GitHub: @Joe1-100
• Twitter: @Joel Kugonza
• LinkedIn: Joel Kugonza

(back to top)

Describe 1 - 3 features you will add to the project.

• A better User Interface
• The inventory functionality
• A chat functionality for users to communicate with Recipe and Food creators

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Write a message to encourage readers to support your project

If you like this project, please give it a star.

(back to top)

Give credit to everyone who inspired your codebase.

I would like to thank Microverse for their continued support. They've provided us with the reading material that have helped us to create this application.

(back to top)

Add at least 2 questions new developers would ask when they decide to use your project.

• Can I reuse this code?

  • Yes sure, feel free.

• Are contributions welcome?

  • Yes please. Contact me at djmulinde@gmail.com and I will be happy to add you as a contributor.

(back to top)

This project is MIT licensed.

(back to top)