Recipes App

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 📝 License

📖 Recipes 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

• Ruby
• Ruby on Rails

Server

• N/A

Database

• PostgreSQL

Key Features

• ROR
• Devise

(back to top)

💻 Getting Started

To get a local copy of this project and run it in your computer, follow these steps.

Prerequisites

In order to run this project you need:

• A working computer.
• Connection to internet.

Setup

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

Clone this repository in the desired folder:

cd my-folder
git clone https://github.com/dennis-every/recipes-app.git

Install

To install this project:

cd recipes-app
code .
bundle install

Usage

To run the project, execute the following command:

rails server

Run Tests

For rails +7, include the following in your gemfile in the development, test group:

group :development, :test do  
  gem 'rspec-rails'
end

and

gem 'rails-controller-testing'

then run:

bundle install

To setup rspec, run the following:

rails generate rspec:install

To run the project tests, execute the following command:

rspec

(back to top)

👥 Authors

👤 Ashmal Zahra

• GitHub: @ashmalzahra
• Twitter: @AshmalZahraa
• LinkedIn: ashmal-zahra

👤 Dennis Every

• GitHub: @dennis-every
• Twitter: @dennis_every
• LinkedIn: dennis-every

(back to top)

🔭 Future Features

• Deployment.

(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!

(back to top)

📝 License

This project is MIT licensed.

(back to top)