An open API service indexing awesome lists of open source software.

https://github.com/alierpm/recipedaily

Recipedaily is a web application designed to help users manage their recipes effortlessly. With features like a dynamic recipe list, public recipes showcase, food management, and a convenient general shopping list, it offers a seamless cooking experience.
https://github.com/alierpm/recipedaily

devise recipe recipe-app recipes ruby-on-rails

Last synced: 2 months ago
JSON representation

Recipedaily is a web application designed to help users manage their recipes effortlessly. With features like a dynamic recipe list, public recipes showcase, food management, and a convenient general shopping list, it offers a seamless cooking experience.

Awesome Lists containing this project

README

        

Recipedaily Logo

🌮 Recipedaily

Your go-to recipe hub for culinary adventures!

# 📗 Table of Contents

- [📖 About Recipedaily](#about-recipedaily)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run Tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Meet the Chefs](#meet-the-chefs)
- [🔮 What's Cooking Next?](#whats-cooking-next)
- [🤝 Let's Cook Together](#lets-cook-together)
- [⭐️ Spice It Up](#spice-it-up)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 About Recipedaily

Welcome to Recipedaily, where the joy of cooking meets the magic of technology. Explore a world of flavors, create, and share your culinary masterpieces with fellow food enthusiasts.

## 🛠 Built With

### Tech Stack

Backend

Frontend

Database

### Key Features

- **Flavorful Authentication:** Log in and register with a touch of Devise magic.
- **Recipe Showcase:** Create, edit, and showcase your recipes to the world.
- **Public Potluck:** Explore a potluck of public recipes and share your culinary creations.

(back to top)

## 🚀 Live Demo

Hungry for a sneak peek? Take a bite at the [Recipedaily Live Demo](https://yourdeployedapplicationlink.com).

(back to top)

## 💻 Getting Started

> The following steps were used in creating this project:

1. Set up the project by creating a new directory from the generated repository.

2. Set up the repository on GitHub and use Gitflow.

3. Initialize the project with Rubocop linters.

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

### Prerequisites

In order to run this project, you need:

1. Ruby installed:
- On macOS using Homebrew:

```sh
brew install ruby
```

- On Windows or Linux, follow the installation instructions from [Ruby's official website](https://www.ruby-lang.org/en/documentation/installation/).

2. Rails Installed:

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:
```sh
git clone https://github.com/AlierPM/Recipedaily.git
```

### Install

Navigate to the Recipedaily directory:

```sh
cd Recipedaily
```

### Usage

Open the project in your preferred code editor:
```sh
cd recipedaily
code .
```

### Run project

To run from the local server, execute the following command:

```sh
rails server
```
### Run tests

To run tests, execute the following command:

```sh
rpec spec
```

(back to top)

## 👥 Meet the Chefs

Let's introduce the brilliant minds behind Recipedaily.

👨‍🍳 **MasterChef Dev**

👤 **Alier Philip Maguet**

- GitHub: [@AlierPM](https://github.com/AlierPM)
- Twitter: [@AlierPM](https://twitter.com/AlierPM)
- LinkedIn: [@AlierPM](https://www.linkedin.com/in/alierphilipmaguet/)

👩‍🍳 **Code Cuisine Creator**

- GitHub: [@codecuisinecreator](https://github.com/codecuisinecreator)
- Twitter: [@codecuisinecreator](https://twitter.com/codecuisinecreator)
- LinkedIn: [Code Cuisine Creator](https://linkedin.com/in/codecuisinecreator)

(back to top)

## 🔮 What's Cooking Next?

The kitchen is buzzing with excitement! Here are some upcoming features:

- [ ] **Recipe Ratings and Reviews**
- [ ] **User Profile Customization**
- [ ] **Integration with External Recipe APIs**

(back to top)

## 🤝 Let's Cook Together

Join the recipe revolution! Contribute to Recipedaily by:

- Reporting Bugs
- Adding Features
- Enhancing Documentation

Feel free to check the [issues page](../../issues/) for ongoing discussions.

(back to top)

## ⭐️ Spice It Up

If you love our project, show your support by starring the repository. It adds a dash of motivation to our culinary journey!

(back to top)

## 🙏 Acknowledgments

We express our gratitude to everyone who contributed to the development of Recipedaily.

Special thanks to [Microverse](https://www.microverse.org/) for providing an incredible collaborative learning environment and making this project possible.

(back to top)

## ❓ FAQ

- **Q: How do I add a new recipe?**

- A: Simply log in, head to your dashboard, and click on the "Create New Recipe" button.

- **Q: Can I share my recipes with others?**

- A: Absolutely! After creating a recipe, toggle the privacy switch to share it with the world.

(back to top)

## 📝 License

This project is [MIT](./License) licensed. We invite you to cook up your own creative ideas using our recipe.

(back to top)