Recipes App

📗Table of Contents

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

📖 Recipes App

The Recipe app keeps track of all your recipes, ingredients. It will allow you to save ingredients, keep track of what you have, create 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 should allow you to make them public so anyone can access them.

🛠 Built With

Tech Stack

• Ruby on Rails 7.1.2
• PostgreSQL

Key Features

• Creation: Users can create new recipes, providing details such as name, preparation time, cooking time, and description.
• Ingredient Database: The app maintains a database of ingredients that users can reference when creating recipes..
• Automatic List Generation: The app generates a shopping list based on the ingredients required for selected recipes and what the user doesn't currently have in their inventory.

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

Install Ruby

Setup

cd my-folder
git clone https://github.com/Alejandroq12/recipe-app.git

Install

Install all necessary dependencies listed in the Gemfile.

bundle install

Install all necessary dependencies listed in the package.json.

npm install

Database

Important: please, rename .env.example to .env and fill out all necessary fields otherwise you will not be able to connect to the database.

Before running the migrations and seeds, ensure that PostgreSQL is installed and running:

sudo service postgresql start

Create database:

rails db:create

Run migrations:

rails db:migrate

Add the seeds:

rails db:seed

Usage

To run the project, navigate to the project directory and execute the following command:

rails server

Run tests

To execute all test suites in the application, use the following command in your terminal:

rspec

If you wish to run only the controller request tests, you can specify the path to your request specs directory:

rspec spec/requests/ 

If you wish to run only the integration tests:

rspec spec/system

Run linter

To run linter, run the following command:

rubocop

npx stylelint "**/*.{css,scss}"

Deployment

Check this project:

• Recipe App : recipe_app

(back to top)

👥 Authors

👤 Julio Quezada

• GitHub: Alejandroq12
• Twitter: @JulioAle54
• LinkedIn: Julio Quezada

👤 Nessrine Macherki

• GitHub: Nessrine Macherki
• LinkedIn: Nessrine Macherki

(back to top)

🔭 Future Features

• User Feedback: Users might have the option to leave reviews or comments on recipes.
• A rating system could be in place for recipes, helping users discover popular or highly-rated dishes.
• Web and Mobile: The app might be accessible through both web and mobile platforms for a seamless user experience.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project please give a star. Thanks in advance.

(back to top)

🙏 Acknowledgments

I would like to thank all of my colleagues who inspire to do my best everyday.

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)