📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run Test
  • Run Linters
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 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.

[Recipe App] is a Ruby on Rails recipe website.

🛠 Built With

Tech Stack

Recipe App is backend project

Database

• PostgreSQL

Key Features

We can do CRUD operations on following things:

• User
• Food
• recipe
• Recipe_food

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Comming Soon 🎈

(back to top)

💻 Getting Started

In order to start with this project do as follows :

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

Prerequisites

In order to run this project you need:

gem install rails

Setup

Clone this repository to your desired folder:

git clone git@github.com:Strangeal/Recipe-app.git

then

cd Recipe-app

Install

Install this project with:

bundle install

Usage

rails s

Run Test

To run app test. run the following commad:

rspec

Run Linters

To run tests, run the following command:

rubocop

OR

rubocop -a

it will automatically correct the errors

(back to top)

👥 Authors

👨‍💻 Justice Bajeri

• GitHub: Link to Github Profile
• Twitter: Link to Twitter Profile
• LinkedIn: Link to LinkedIn Profile

👤 Nahnah Ahjuwah

• GitHub: @NahnahAJ
• Twitter: @NahnahAhjuwah
• LinkedIn: Felicia-Awuah

(back to top)

🔭 Future Features

In upcoming weeks I will add some features as mentioned below

• Authentication and Authorization
• High UI

(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 then please give a ⭐️ and also share your feedback using github_issues.

(back to top)

🙏 Acknowledgments

❤️ RoR Documentation

(back to top)

📝 License

This project is MIT licensed.

(back to top)