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

https://github.com/elisha-tetteyfio/recipe-app

The recipe app helps you to create and store recipes of foods, and to be able to determine which food items you need for a given recipe.
https://github.com/elisha-tetteyfio/recipe-app

css rails ruby

Last synced: 3 months ago
JSON representation

The recipe app helps you to create and store recipes of foods, and to be able to determine which food items you need for a given recipe.

Awesome Lists containing this project

README

          

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

# 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. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them.

## Built With

- Major: Ruby, HTML,CSS
- Frameworks: Rails
- Technologies: Git, Gitflow, Linters, Github, PostgreSql

## Live Demo (not available yet)

[Live Demo Link](https://livedemo.com)

## Getting Started

To get a local copy up and running follow these simple example steps.

### Prerequisites
- Have a computer and internet connection
- Have Ruby installed on your computer
- Have Rails installed on your computer
- Have a basic knowledge of Ruby and OOP concept
- Have a basic knowledge of Rails
- Have a general understanding of what testing is
- Have visual-studio code or any other code editor installed on your computer.

### Setup
- Open your terminal in the folder where you want to have the project and run `git clone https://github.com/Elisha-Tetteyfio/recipe-app` to clone the project.
- Run `cd recipe-app` to move to the project directory.

### Install
- Make sure to have installed POSTGRESQL

### Usage
- Run `rails s` to start the app, then follow the given link provided in the console.
- Run `rails c` to open an interactive ruby session

### Run tests
- Run `rspec`

## Authors

👤 **Elisha Tetteyfio**

- GitHub: [@Elisha-Tetteyfio](https://github.com/Elisha-Tetteyfio)
- Twitter: [Elisha](https://twitter.com/Nii_AlYasa)
- LinkedIn: [Elisha Tetteyfio](https://linkedin.com/in/elisha-tetteyfio)

👤 **Bruk Teshome**

- GitHub: [@githubhandle](https://github.com/bruk19)
- Twitter: [@twitterhandle](https://twitter.com/Bruktesh)
- LinkedIn: [LinkedIn](https://linkedin.com/in/bruk-teshome-ab4325226)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Elisha-Tetteyfio/recipe-app/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Hat tip to anyone whose code was used
- Inspiration
- etc

## 📝 License

This project is [MIT](./LICENSE) 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._