📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipes App
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
  • Prerequisites
  • Install \& Setup
  • Tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Recipes App

Recipes App is a web application crafted with Ruby on Rails and powered by PostgreSQL. This platform is designed to make recipe creation, discovery, and sharing a seamless experience. With this app users can easily document and share their favorite recipes in an engaging blog-style format.

🛠 Built With

Tech Stack

Key Features

• Login and Sign Up features implemented using Devise
• Allows users to create and view recipes as well as add food items to their profile
• Shopping list feature allows users to complie a shopping list of all missisng ingredients

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To start and run this project

bundle install

rails s

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

Prerequisites

In order to run this project you need:

    ruby >= 3.2.0
    rails >= 7.0
    postgres >- 15.3

As well as:

• IDE to edit and run codes.
• Git.
• PostgreSQL installed

Install & Setup

To setup and install this project, follow the below steps:

• Clone this project by the command:

$ git clone git@github.com:sunga12/Recipe-App-RoR.git

• Then switch to the project folder:

$ cd Recipe-App-RoR

• Install the required dependencies with bundle install
• Install npm dependencies with npm install
• Run rails db:setup
• Run rails db:migrate
• With Ruby on Rails and PostgreSQL installed in your environment, you can run rails server, rails s or ./bin/dev to run the website.

Tests

• Run rails db:seed RAILS_ENV=test to seed the testing database
• Run rspec

(back to top)

👥 Authors

👤 Sungabanja Thawethe

• GitHub: @Sunga12
• LinkedIn: Sungabanja Thawethe

👤 Mahmoud Rizk

• GitHub: @hassanShakur
• LinkedIn: Mahmoud El Erqsousy

(back to top)

🔭 Future Features

• [ ] Allow users to pin/save recipes
• [ ] Add more styling to improve the UI
• [ ] Pagination or infinite scrolling for the lists.

(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, kindly leave a star!

(back to top)

🙏 Acknowledgments

• We would like to thank Microverse for providing the project specifications as well as the lessons leading up to the project that made completing it possible.

(back to top)

📝 License

This project is MIT licensed.

(back to top)