Recipebean

Modernized cooking app

Currently down 😔. Will be up soon!

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contact

About The Project

Having a passion for cooking, I wanted a personalized digtial cookbook to store my recipes. There are many great apps out there, but are either over-saturated with features and stray away from a personalized cookbook, or have clunky UI that are not intuitive to the user. The goal of this project was to create a simple and intuitive UI cookbook app to store you recipes.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how setup the project locally:

Prerequisites

• npm

  npm install npm@latest -g

• Cloudinary - setup a cloudinary account to get necessary information to store recipe cover images:

  CLOUDINARY_CLOUD_NAME =
  CLOUDINARY_FOLDER =
  CLOUDINARY_API_KEY =
  CLOUNDINARY_API_SECRET =
  

• Redis - setup redis to store sessions (default redis URL)

  REDIS_URL = 127.0.0.1:6379
  

• PostgreSQL - setup local PostreSQL for your database

  POSTGRES_USER =
  POSTGRES_PASSWORD =
  POSTGRES_DB_NAME =
  POSTGRES_HOST =
  POSTGRES_PORT =
  

Installation

1. Clone the repo

   git clone https://github.com/RandumbWilliam/recipebean.git

2. Grap the necessary environment variables from Cloundinary and PostgreSQL

3. Create a .env and fill in the necessary environment variables provided by .env.example for both client and server

4. Run your redis server

   redis-server

5. server - install NPM packages

   npm install

6. server - run watch

   npm run watch

7. server - run dev

   npm run dev

8. client - install NPM packages

   npm install

9. client - run dev

   npm run dev

(back to top)

Roadmap

• Add Ingredient Shopping List
• Add Meal Planner
• Add Additional UI tweaks

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

William Zhen - https://www.linkedin.com/in/william-zhen/ - w2zhen@uwaterloo.ca

Project Link: https://github.com/RandumbWilliam/recipebean

(back to top)