Recipe App

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
      • Check your Ruby version or install it
    • Clone the repository
    • Install
      • .env File Structure
    • Usage
    • Testing
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Recipe App

It is a simple Recipe App where you can post recipes and foods, and edit or remove them.

Recipe App is an application for sharing lessons and experiences on coding with Ruby on Rails!

🛠 Built With

Tech Stack

This Web App was built with Ruby on Rails, using Gitflow and customized Linters

Client

• Ruby

Server

• Rails

Database

• PostgreSQL

Key Features

• Posting Recipes to share public and private user-created recipes
• Shopping to trade plates
• Display preparation and cooking time

(back to top)

🚀 Live Demo

Coming soon...

(back to top)

💻 Getting Started

Prerequisites

Check your Ruby version or install it

ruby --version && irb

The ouput should start with something like ruby 3.1.2

If not, install the right ruby version using rbenv (it could take a while):

rbenv install 3.1.2

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

Clone the repository

git clone https://github.com/dialite/recipe-app.git
cd blog-app-ror

Install

• Ensure you have PostgreSQL installed before running the application psql --version
• Run bundle install
• Create a .env file in the project's root folder to assign variable values for the psql database (linked to the config/database.yml)
• Run rails db:create and then rails db:migrate
• Run rails server
• Open Browser http://localhost:3000/

.env File Structure

This is the intended file content for the .env file:

POSTGRES_HOST='localhost'
POSTGRES_USER='username'  # <-- replace here
POSTGRES_PASSWORD='password'  # <-- replace here
POSTGRES_DEV_DB='recipe_ror_app_dev'
POSTGRES_DEV_DB='recipe_app_dev'
POSTGRES_TEST_DB='recipe_app_test'
POSTGRES_PROD_DB='recipe_app_prod

Replacing the variable values where needed (most importantly username and password)

Usage

To run the project, execute the following command:

  rails server

Testing

To test and utilize the code, use the terminal and run ruby by inputting irb in the command line, or by using an extension in Visual Studio Code like Code runner

The user then can modify and play with the files as needed

(back to top)

👥 Authors

👤 raymond olisa

• GitHub: @dialite
• LinkedIn: Raymond Olisa

👤 Tamana Balkhi

• GitHub: @tamana-Balkhi
• LinkedIn: Tamana Balkhi

(back to top)

🔭 Future Features

• Structured user rights
• Add wish list
• Time counter for food preparation

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

🙏 Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• To all the collaborators for the Readme Template
• The Microverse Team

(back to top)

📝 License

This project is MIT licensed.

(back to top)