Yonashenok/Recipe-app

Recipe App keeps track of all your recipes and ingredients. 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

Recipe App

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👤 Author
• • 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Recipe App

Recipe App keeps track of all your recipes and ingredients. 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

Ruby on rails

Key Features

• user
• foods
• recipes
• shopping list
• public recipes

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Code Editor (Vs Code)

Terminal

Install ruby on your computer

Install rails on your compute

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Yonashenok/Recipe-app.git

  cd Recipe-app

Install

Install this project with:

 bundle install

Usage

To run the project, execute the following command:

  rails server
  or
  rails s

Run tests

To run tests on linters, run the following command:

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

  rubocop

To run test coverages, run the following command:

  rspec spec

(back to top)

👤 Author

👤 Yonas Henok

• GitHub: @YonasHenok
• Twitter: @YonasHenok3
• LinkedIn: Yonas Henok

👤 Tchasinga jacques

• GitHub: @Tchasinga Jack
• Twitter: @tchasingajacques
• LinkedIn: @tchasingajaques

(back to top)

🔭 Future Features

• Add More Functionality

(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 please give it a Start ⭐️.

(back to top)

🙏 Acknowledgments

• Project from Microverse Ruby on rails 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.

❓ FAQ

• Can I Fork it and Imporove on it

  • Yes, You can, 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)