Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/adeola003/recipe_app

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/adeola003/recipe_app
Owner: adeola003
License: mit
Created: 2023-07-31T07:30:13.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-08-05T06:30:53.000Z (over 1 year ago)
Last Synced: 2024-11-11T03:52:07.184Z (3 months ago)
Language: Ruby
Size: 203 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        Adeola & Atif



  
**Recipe App**




# 📗 Table of Contents

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

- [📖 \[Catalog of my things\] ](#--)

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

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

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

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

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

  - [🤝 Contributing ](#-contributing-)

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

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 [Recipe App] 

**[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 

### Tech Stack 

  Ruby

  Rails

  IRB

  SQL

  Rspec

  Vscode

  Devise

  Capybara

### Key Features 

- **[Schema file is created for the project]**

- **[Database is connected to rails app]**

- **[Use database migration files to maintain database schema]**

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

### Setup

Clone this repository to your desired folder:

```sh

  git clone https://github.com/adeola003/Recipe_App.git

  cd Recipe_App

```

> Install Gemfile

```

$ bundle install

```

> Run the app

```

$ rails s

```

## Rubocop

> To check linter

```

$ rubocop --color

```

## Rspec

> To run testing

```

$ rspec

```

### Install

-Command: bundle install, npm install

### Usage

- Step 1: Use the `rubocop` command to raise rubocop errors

- Step 2: `rubocop -A` for autorection

👤 **Abdel-Khafid SALAOU**

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

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

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdel-khafid-salaou)

👤 **Atif Zada**

- GitHub: [@Atif-Zada](https://github.com/AtifZada)

- LinkedIn: [@Atif-Zada](https://linkedin.com/in/AtifZada)

## 🔭 Future Features 

- [ ] **[Will-add-more-intersting features]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issue page](https://github.com/adeola003/Recipe_App/issues)

(back to top)


## ⭐️ Show your support 

If you like this repo dont forget to give it a star.

(back to top)


## 🙏 Acknowledgments 

I would like to thank the Microverse community and the partners.

(back to top)


## 📝 License 

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

(back to top)