devMunyi/Recipe-App

The Recipe app keeps track of all your recipes, ingredients, and inventory. It will allow you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe.

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

📖 Recipe App

The Recipe app keeps track of all your recipes, ingredients, and inventory. It will allow you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them.

🛠 Built With

Tech Stack

Client

• Bootstrap
• JavaScript

Server

• Ruby on rails

Database

• PostgreSQL

Key Features

• [keeps track of all your recipes, ingredients, and inventory]
• [allow you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe]
• [allow you to make recipes public so anyone can access them]

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need followed installed on your computer:

• Ruby v3+,
• Rails v7+
• PostgreSQL
• An IDE e.g Visual studio code.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

git clone https://github.com/devMunyi/Recipe-App

• Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd Recipe-App

Install

To install all dependencies, run:

bundle install

Usage

To run the project, follow these instructions:

• After Cloning this repo to your local machine.
• To get it running on your machine, you may open the project on your IDE and open the terminal
• On the terminal you can run:

rails s OR rails server

• After, you can follow along the app and run the appropriate option from navsigations to interact with it.

Run tests

• To run rubcop tests, run the following command:

rubocop

• To run rspec tests, run the following command:

rspec

(back to top)

👤 Authors

👤 Samuel Munyi

• GitHub: @devMunyi
• LinkedIn: Samuel Munyi
• Twitter: @munyi_sam

👤 Tarik Bouari

• GitHub: @tarikbouari
• LinkedIn: tarikbouari
• Twitter: @tarikbouari

(back to top)

🔭 Future Features

• Implement more methods.
• Improve the UI.
• Deploy to live server.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project and how I managed to build it!

(back to top)

🙏 Acknowledgments

• The original design ideal from Microverse💕.
• Project from Microverse Ruby / Database and Interviewing module.
• Thanks to the Microverse team for the great curriculum.
• Thanks to the Code Reviewer(s) for the insightful feedbacks.
• A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
• Hat tip to anyone whose code was used.

(back to top)

❓ FAQ

• Can I fork and reuse the repository

  • Yes please, feel free.

• Can I improve the repository, and my changes will be accepted if they are good?

  • Yes please, nice ideas are welcome, please.

(back to top)

📝 License

This project is MIT licensed.

(back to top)