README.md

Recipe App

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Tests
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Recipe App

This is a Recipe App created with Ruby on Rails + Postgresql, as a Rails Group Capstone Project.

It manages Recipes, that Users who sign-up can add to the app, make them either public or private, add ingredients, foods and generate shopping lists based on those ingredients.

Without sign-up, the visitor can only browser through the public recipes.

🛠 Built With

Tech Stack

Ruby

• Ruby

Rails

• Guides

Database

• PostgreSQL

RSpec

• In Rails

Devise

Cancancan

Linters

• RoR linters

Key Features

• Sign-up
• Add new recipe
• Add recipe ingredient
• Add Food
• Generate Shopping List

(back to top)

💻 Getting Started

This repository includes files with Ruby language.

Prerequisites

In order to run this project you need to have install:

• Ruby check this to install it.
• Rails check this to install it.
• Postgresql check this to install it.

Setup

Clone this repository to your desired folder by opening the terminal and running the following command:

  git clone [email protected]:hajnaloltyan/recipe-app.git

Usage

Create the database and start the app:

  rails db:create
  rails db:migrate
  rails server

Navigate to http://localhost:3000 and see the functional app.

For linter errors:

  rubocop

Tests

For running tests:

  rspec

(back to top)

👥 Author

👤 Cristian Villa

• GitHub: @Cristian Villa
• LinkedIn: @Cristian Villa

👤 Hajnalka Oltyan

• GitHub: @hajnaloltyan
• LinkedIn: Hajnal Oltyan

(back to top)

🔭 Future Features

• Attaching media files for new recipes to have image of the food

(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 you could clone the repo and work with it or do the changes in a new branch. Also you could let a message with your thoughts.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing the necessary resources for this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)