RoR-recipe-app

Getting Started

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 new 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 allows you to make them public so anyone can access them.

📗 Table of Contents

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

📖 RoR-recipe-app

For simpler understanding the RoR-recipe-app follows the following Entity Relationship Diagram.

🛠 Built With

Tech Stack

Server

• Locally using WSL

Key Features

Key features of the repository.

• Was created with RoR
• Has a database that follows the diagram above
• Has a login and registration authentication system with the help of devise
• Has Rubocop to enforce best ruby practices

(back to top)

💻 Getting Started

Follow these steps in order to run ruby code.

Prerequisites

First you need to ensure that you have ruby installed in your computer.

Install

It varies depending on your operating system so here are some links to help you install it on Windows and on Ubuntu.

For MacOS run the following commands

  brew install rbenv ruby-build
  # Add rbenv to bash so that it loads every time you open a terminal
  echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
  source ~/.bash_profile

  # Install Ruby
  rbenv install 3.0.1
  rbenv global 3.0.1
  ruby -v

This example shows how to install Ruby 3.0.1 which was the latest version in April 2021, but you can check to see if there is a newer version here. Iy is also assumed that you have homebrew already installed on your Mac.

Next you'll want to intall Rails and postgreSQL by running the following commands, but you can also use any SQL application of your choice

  gem install rails -v 7.0.6

  sudo apt install postgresql libpq-dev

And start postgreSQL and the app with

  sudo service postgresql start

  rails server

Setup

Once you have ruby installed, run this command to get the project on your local machine.

  git clone git@github.com:jlvFlores/RoR-recipe-app.git

Usage

Once you have the project installed, access the project's root directory usign this command

  cd RoR-recipe-app

And lastly, run this command to see the project in in your browser.

  rails server

(back to top)

👥 Authors

Here is a mention all of the collaborators of this project.

👤 Author 1

• GitHub: @jlvFlores
• Twitter: @JoseVaz44312762
• LinkedIn: Jose (Luis) Vazquez

👤 Author 2

• GitHub: @federicaulzurrun
• LinkedIn: Federica Ulzurrun

👤 Author 3

• GitHub: @kkolade
• Twitter: @kola_kolade

(back to top)

🔭 Future Features

The following are the future features that will be added to the project.

• Further accessibility
• New color template
• Add pagination
• It will probably not take over the world

(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 can give me a hand by recommending me to potential employers! 😉🤝

(back to top)

🙏 Acknowledgments

I would like to thank those who have motivated me to keep on fighting despite how tough the journey may become.

(back to top)

📝 License

This project is MIT licensed.

(back to top)