Recipe App

📗 Table of Contents

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

📖 [RecipeApp]

The [Recipe app] Project is a web page that allows users to create foods and recipes for themselves and choose if a recipe is public so everyone can see it. Users can generate a shopping list for his own recipes and also, users can register with a username and password and see public recipes from other users as well. Built with RoR.

🛠 Built With

• Ruby on Rails
• PostgreSQL

Tech Stack

List of technologies used for this project

Client

• Ruby

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Create and Remove Foods for users
• Create and Remove new Recipes
• Set recipes to Public or Private
• See all public recipes from other users
• Generate a shopping List for all recipes of the user based in his food
• Add Foods to recipes

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

gem install ruby

• Browser (Google Chrome, Mozilla Firefox, Safari or any other browser)

Setup

Clone this repository to your desired folder:

  cd RecipeApp
  git clone git@github.com:flemton/RecipeApp.git

Install

Install this project with:

  cd RecipeApp
  bundle install

Usage

To run the project, execute the following command:

rails tailwindcss:watch
control + c 
rails s

Note: If there are any errors consider adding your necesary username and password in database.yml for setting up your local enviroment and use the following comand:

rails db:create db:migrate
rails s

Run tests

To run tests, run the following command:

rails tailwindcss:watch
control + c
rspec spec

(back to top)

👥 Authors

👨🏼‍🚀 Alhassan Osman 🎵

• GitHub: @flemton
• Twitter: @oalhassan847
• LinkedIn: newtongh

👨🏼‍🚀 Juan Diego Guerra (JD) 👾

• GitHub: @JuanDiegoGuerra
• • Twitter: @jdxelric147
• LinkedIn: Juan Guerra

(back to top)

🔭 Future Features

• Improve UI
• Add more functionality
• Add Inventory List
• [Add links to shopping ingredients]
• [Add ability to edit user details]

(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 consider giving it a star⭐

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for giving us the opportunity to learn and grow as developers and also We like to thank our family, they are all our support. 🌟

(back to top)

❓ FAQ

• Do I need to install any program before running this project?

  • Yes, you need to install Ruby
  
  

• Can I use this project for my own purposes?

  • Yes, you can.

(back to top)

📝 License

This project is MIT licensed.

(back to top)