Table of Contents
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.
This is an example of how setup the project locally:
-
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 =
-
Clone the repo
git clone https://github.com/RandumbWilliam/recipebean.git
-
Grap the necessary environment variables from Cloundinary and PostgreSQL
-
Create a
.env
and fill in the necessary environment variables provided by.env.example
for bothclient
andserver
-
Run your redis server
redis-server
-
server
- install NPM packagesnpm install
-
server
- run watchnpm run watch
-
server
- run devnpm run dev
-
client
- install NPM packagesnpm install
-
client
- run devnpm run dev
- Add Ingredient Shopping List
- Add Meal Planner
- Add Additional UI tweaks
Distributed under the MIT License. See LICENSE.txt
for more information.
William Zhen - https://www.linkedin.com/in/william-zhen/ - w2zhen@uwaterloo.ca
Project Link: https://github.com/RandumbWilliam/recipebean