Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

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.
https://github.com/nkaleth/recipe-app

bootstrap5 ruby-on-rails

Last synced: 15 days ago
JSON representation

Host: GitHub
URL: https://github.com/nkaleth/recipe-app
Owner: Nkaleth
License: other
Created: 2023-05-22T15:26:10.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-05-28T22:36:44.000Z (over 1 year ago)
Last Synced: 2024-10-16T07:51:59.767Z (30 days ago)
Topics: bootstrap5, ruby-on-rails
Language: Ruby
Homepage:
Size: 8.23 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ![](https://img.shields.io/badge/Microverse-blueviolet)



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Recipe App ](#-recipe-app-)

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

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

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

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage ](#usage-)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

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

  - [🤝 Contributing ](#-contributing-)

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

  - [📝 License ](#-license-)

# 📖 Recipe App 

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. 

## 🛠 Built With 

### Tech Stack 

  Client

  
 

    Linters


  


  Server

  


    ROR

  


Database

  


    PostgreSQL

  


### Key Features 

- Use RubyGems as a software package system.

- Use database migration files to maintain database schema.

- Understand ORM

(back to top)


## 💻 Getting Started 

### Prerequisites

In order to run this project you need:

- [Ruby on Rails](https://rubyonrails.org/) installed and running. To get more information, read the [installation guide](https://guides.rubyonrails.org/).

- [PostgreSQL](https://www.postgresql.org/) installed and running

### Setup

Clone this repository to your desired folder:

```

  git clone https://github.com/Nkaleth/Recipe-app.git

  cd Recipe-app

```

### Install

```sh

  bundle install

```

```sh

  npm install

```

```sh

  rails css:install:bootstrap

```

### Usage

To run the project, execute the following command:

```sh

  rake db:drop db:create db:migrate db:seed

  rails server

```

(back to top)


- ## 👤 Author 

 

👤 **Koami NOGBEDJI**

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

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

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

👤 **Nilton Segura**

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

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

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

(back to top)


## 🔭 Future Features 

 - Integration specs for Views and fixing n+1 problems

 - Add Food

 - Add Receipe

 - Generate shoping list

 - Add tests

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project and want to support me make cooler projects Give this project a Star.

(back to top)


## 📝 License 

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

(back to top)