Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/recipe_app

Recipe App keeps track of all your 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.
https://github.com/stephenkati/recipe_app

postgresql recipe-app rubyonrails

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/stephenkati/recipe_app
Owner: stephenkati
License: mit
Created: 2023-07-31T06:35:00.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-08-02T18:24:09.000Z (over 1 year ago)
Last Synced: 2024-09-27T16:04:04.073Z (about 2 months ago)
Topics: postgresql, recipe-app, rubyonrails
Language: Ruby
Homepage:
Size: 133 KB
Stars: 6
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # recipe_app



# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

- [📝 License](#license)

# 📖 [Recipe App] 

**[Recipe App]** keeps track of all your 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.

## 🛠 Built With 

### Tech Stack 

  Ruby on Rails

  


    https://rubyonrails.org/

  


### Key Features 

- **[Recipe list]**

- **[Food list]**

- **[Shopping list]**

(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

- Install Rails

- Install Rspec

- Install Postgresql

### Setup

Clone this repository to your desired folder:

```

  git clone https://github.com/stephenkati/recipe_app.git

```

### Install

Install this project with:

```

  cd recipe_app

  bundle install && npm install

```

### Usage

To run the project, execute the following command:

```

  rails s

```

or

```

./bin/dev

```

### Run tests

To run tests, run the following command:

```

  rubocop --color

```

```

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

```

```

  rspec spec

```

### Deployment 

  - [N/A]

(back to top)


## 👥 Authors 

👤 **STEPHEN KATULI**

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

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

👤 **Sasan Moshirabadi**

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

- LinkedIn: [LinkedIn](https://linkedin.com/in/sasan-moshirabadi)

(back to top)


## 🔭 Future Features 

- [ ] **[Recommended recipes]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/stephenkati/recipe_app/issues).

(back to top)


## ⭐️ Show your support 

If you like this project please show support by staring ⭐️.

(back to top)


## 🙏 Acknowledgments 

* We would like to thank my Microverse team and my coding partners for their support and guidance.

(back to top)


## 📝 License 

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

(back to top)