Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

The app keeps track of recipes and 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. It is built using Ruby on Rails.
https://github.com/sonickmumba/recipe-app

cancancan devise rails rspec ruby-gem ruby-on-rails

Last synced: 20 days ago
JSON representation

Host: GitHub
URL: https://github.com/sonickmumba/recipe-app
Owner: Sonickmumba
Created: 2023-01-15T17:49:15.000Z (almost 2 years ago)
Default Branch: development
Last Pushed: 2023-01-21T11:24:50.000Z (almost 2 years ago)
Last Synced: 2024-10-10T09:42:13.156Z (about 1 month ago)
Topics: cancancan, devise, rails, rspec, ruby-gem, ruby-on-rails
Language: Ruby
Homepage:
Size: 653 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 16
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        

  

  

  

  

# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 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)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 Recipe app 

**Blog app with Rails** 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 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:

# ERD Diagram

![recipe_erd_2_members](https://user-images.githubusercontent.com/106140591/213797563-6132eecb-1a6d-435d-8dce-fdf3b64212d9.png)

## 🛠 Built With 

### Tech Stack 

  Languages

  


    Ruby

    Javascript

    HTML

    CSS

  


  Frameworks

  


    Ruby on Rails

  


  Server

  


    Puma

  


Database

  


    PostgreSQL

  


Testing library

  


 RSpec   

  


### Key Features 

- **[A login page]**

- **[A registration page]**

- **[A food list (with all CRUD implementation, except for 'update')]**

- **[A recipes list (with all CRUD implementation, except for 'update')]**

- **[A general shopping list view (all missing food for all your recipes and total price)]**

- **[A list of all public recipes from other users with their names and total prices]**

(back to top)


## 🚀 Live Demo 

- Comming soon

(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 version : `ruby 3.1.2p20`

    run `ruby -v`

> Database : **PostgreSQL**

```sh

 gem install rails

```

### Setup

Clone this repository to your desired folder:

Example commands:

```sh

  cd my-folder

  git clone [email protected]:Sonickmumba/Recipe-app.git

```

-

### Install

Install this project with:

```

  cd Recipe-app

  bundle install

```

-

### Usage

To run the project, execute the following command:

```sh

  rails server or rails s

```

-

### Run tests

The app is tested using Rspec library you can check the tests by opening your terminal, then change the directory to the location of this repo using this command `cd file_path`, then run this command `gem install rspec`, finally run this command `rspec spec` or `rspec spec --format doc` for documented test results you should see a screen like that comming soon

### Deployment

You can deploy this project using:

- Comming soon

(back to top)


## 👥 Authors 

👤 **Sonick Mumba**

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

- Twitter: [@Sonick](https://twitter.com/MumbaSonick)

- LinkedIn: [Sonick Mumba](https://linkedin.com/in/sonickmumba)

(back to top)


## 🔭 Future Features 

- [ ] **[Creating a data model]**

- [ ] **[Processing data in models]**

- [ ] **[Validations and Model specs]**

- [ ] **[Setup and controllers]**

- [ ] **[Controllers specs]**

- [ ] **[Views]**

- [ ] **[Add forms]**

- [ ] **[Integration specs for Views and fixing n+1 problems]**

- [ ] **[Add Devise]**

- [ ] **[Add authorization rules**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project it a thumb up : 👍 and share this projects with your friends

(back to top)


## 🙏 Acknowledgments 

I would like to thank...

- Thanks to **Microverse** for giving the opportunity to learn

- Code reviewers and coding partners

- Hat tip to anyone whose code was used

- Inspiration

(back to top)


## 📝 License 

This project is [MIT](https://choosealicense.com/licenses/mit/) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)