https://github.com/ansaribrahim/recipe-app

This 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 recipes, and generate a shopping list based on what you have and what you are missing from a recipe.
https://github.com/ansaribrahim/recipe-app

cancancan capybara devise factory gitflow license linters rails render rspec ruby rubyonrails tailwindcss testing

Last synced: 14 days ago
JSON representation

This 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 recipes, and generate a shopping list based on what you have and what you are missing from a recipe.

• Host: GitHub
• URL: https://github.com/ansaribrahim/recipe-app
• Owner: AnsarIbrahim
• License: mit
• Created: 2023-10-13T11:56:30.000Z (about 1 year ago)
• Default Branch: devlopment
• Last Pushed: 2023-10-13T15:55:54.000Z (about 1 year ago)
• Last Synced: 2024-10-10T05:01:07.926Z (about 1 month ago)
• Topics: cancancan, capybara, devise, factory, gitflow, license, linters, rails, render, rspec, ruby, rubyonrails, tailwindcss, testing
• Language: Ruby
• Homepage: https://recipeapp-85xl.onrender.com/
• Size: 96.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




    


# Recipe App



## 📗 Table of Contents

- [📖 Blog app ](#-blog-app-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

    - [🚀 Live Demo ](#-live-demo-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

  - [👥 Author ](#-author-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 Recipe 

**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 recipes, and generate a shopping list based on what you have and what you are missing from a recipe.

## 🛠 Built With 

### Tech Stack 

  Server

    
Ruby

    
Rails


  Database

    
Postgres


### Key Features 

- Keep track of Ingredients

- Keep track of Recipes

- Keep track of Inventory

- Generate a shopping list

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://recipeapp-85xl.onrender.com/)

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

```

    ruby >= 3.2.0

    rails >= 7.0

    postgres >- 15.3

```

### Setup

Clone this repository to your desired folder:

```bash

  git [email protected]:marvin-nyalik/Recipe.git

```

You need to setup database for these project

```

  development = recipe_dev

  test        = recipe_test

  production  = Recipe_production

```

or you can use your own database and change the ```config/database.yml```

```yml

  default: &default

    adapter: postgresql

    encoding: unicode

    pool: 5

    username: [your_username]

    password: [your_password]

    host: localhost

  development:

    <<: *default

    database: [your_database_for_development]

  test:

    <<: *default

    database: [your_database_for_test]

  production:

    <<: *default

    database: [your_database_for_production]

```

### Install

Install this project with:

```bash

  cd Recipe

  bundle install

```

it will install the required gemfile for running the project

### Usage

to use this project:

```ruby

   rails server -p 3000

```

```

  rails tailwindcss:watch

```

it will run the server on ```localhost:3000```

(back to top)


## 👥 Author 

👤 MD. Nohain Islam

- GitHub: [    @githubhandle](https://github.com/Zafron047)

- Twitter: [    @twitterhandle](https://twitter.com/NohainZ)

- LinkedIn: [  LinkedIn](https://www.linkedin.com/in/nohain-islam/)

👤 **Marvin Otieno**

- [GitHub](https://github.com/marvin-nyalik)

- [WellFound](https://wellfound.com/u/marvin-otieno)

- [Twitter](https://twitter.com/NyalikMarvin)

👤 **Ansar Ibrahim**

- [GitHub](https://github.com/AnsarIbrahim)

- [LinkedIn](https://linkedin.com/in/ansar-ibrahim/)

- [Twitter](https://twitter.com/ansaradheeb)

(back to top)


## 🔭 Future Features 

- [ ] Add checkout

- [ ] Implement in-app communication

- [ ] Add recipe preparation video links

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/AnsarIbrahim/Recipe-App/issues).

(back to top)


## ⭐️ Show your support 

If you like this project you can share this project to your friend

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for defining these project requirements and my Coding Partners

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)