Table of Contents

• Table of Contents
• Recipe App
  • Built With
    • Tech Stack
    • Key Features
  • Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • Authors
  • Future Features
  • Contributing
  • Show your support
  • Acknowledgments
  • FAQ (OPTIONAL)
  • 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. 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

Key Features

• read public recipes and their ingredients
• authentication and authorization
• add/delete foods
• add/delete recipes
• add/edit/delete ingredients
• make a recipe private/public
• generate shopping list

Getting Started

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

Prerequisites

In order to run this project you need:

• GitHub account;
• Git installed on your OS;
• VSCode (or another code editor);
• modern browser (supporting HTML5 and CSS3) is highly recommended;
• Ruby installed;
• Ruby on Rails installed;
• Node.js and npm installed.

Setup

Clone this repository to your desired folder:

Login to your GitHub account. Clone this repository to your desired folder:

cd my-folder git clone [email protected]:GhostEsso/ror-recipe-app.git

Setup database:

sudo -u postgres createuser --interactive --pwprompt (provide the username and password described in config/database.yml)

Install

Install the dependencies:

gem install npm install

Create database:

bin/rails db:create

(OPTIONAL) Fill the database with sample records:

bin/rails db:seed

Usage

To run the server:

rails server

Open http://localhost:3000 to view it in your browser.

Run tests

To run tests, run the following command:

rspec

You can also check linter errors by running these commands:

rubocop

(OPTIONAL) For testing the confirmation emails:

gem install mailcatcher

Open http://localhost:1080 to view it in your browser.

Authors

Essohanam TAMBANA

• GitHub: @GhostEsso
• Twitter: @TambanaEssohana
• LinkedIn: Tambana Essohanam

Javier Hernandez

• GitHub: @wickathou
• LinkedIn: @javierjhm
• Portfolio: @End Design Co.

Future Features

• add inventories list (with all CRUD implementation)
• add food list for a given inventory (with all CRUD implementation)
• add inventory shopping list, a shopping list, but only taking into consideration a chosen recipe and inventory
• improve UX/UI design

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project just star it!

Acknowledgments

We would like to thank the Microverse program for the knowledge and skills we have acquired in Modules 1-5.

We are grateful to all previous project reviewers for their advice. Thanks to them we could build this app.

FAQ (OPTIONAL)

• Why is there no Live Demo link?

  • This is a student project and the Live Demo will be added after reaching the corresponding phase of the project.

License

This project is MIT licensed.