Regs-cipe Cookbook

A small community for home chefs sharing their best recipes, built with NodeJS

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Features
  • Color Reference
  • Environment Variables
• Getting Started
  • Prerequisites
  • Run Locally
  • Deployment
  • UI Prototype Design
• Roadmap
• Contributing
  • Code of Conduct
• FAQ
• License
• Contact
• Acknowledgements

🌟 About the Project

📷 Screenshots

👾 Tech Stack

Client

• Javascript

Server

• Express.js

Database

• MongoDB

🎯 Features

• Add the recipe to the bookmark.
• Authentication.
• Filter recipes by tags.
• Ingredient shopping list.
• Post comments on recipes.
• Rate recipes.
• Reply to comments.
• Search recipes by words.
• Submit blogs.
• Submit recipes.
• Upload images to cloudinary.
• View bookmarks.
• View recipes.
• View relevant recipes.

🎨 Color Reference

Color	Hex
Primary Color	#6EBE3B

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file:

• App configs:

  SESSION_SECRET: A secret used to sign the session ID cookie. Read more: expressjs/session.

• Cloudinary configs:

  CLOUDINARY_NAME: The name of your Cloudinary account. Used to build the public URL for all your media assets.

  CLOUDINARY_API_KEY: Used together with the API secret to communicate with the Cloudinary API and sign requests.

  CLOUDINARY_API_SECRET: Used together with the API key to communicate with the Cloudinary API and sign requests.

• MongoDB configs:

  MONGODB_URI: An URI to connect to your database.

E.g:

# .env
SESSION_SECRET = my-secret-key

CLOUDINARY_NAME='diy3d...'
CLOUDINARY_API_KEY='5578258...'
CLOUDINARY_API_SECRET='8fxUY5Zn...'

MONGODB_URI = 'mongodb+srv://{username}:{password}@501cluster.evfgb.mongodb.net/test?retryWrites=true&w=majority'

You can also check out the file .env.example to see all required environment variables.

🧰 Getting Started

‼️ Prerequisites

This project uses Yarn as package manager:

npm install --global yarn

🏃 Run Locally

Clone the project:

git clone https://github.com/SE-COURSE-19CLC-FITUS/501recipe.git

Go to the project directory:

cd 501recipe

Install dependencies:

yarn

Start the server:

yarn start

OR:

Run with nodemon:

yarn dev

---

Access server:

The server will run on: http://localhost:3000/

🚩 Deployment

To deploy this project on Heroku:

🖼️ UI Prototype Design

Our web UI prototype design using Figma:

🧭 Roadmap

• Migrate from npm to yarn.
• Remove secrets from .env file.

👋 Contributing

Contributions are always welcome!

📜 Code of Conduct

Please read the Code of Conduct.

❔ FAQ

• Is this project still maintained?

  • Yes, but we will only update UI, docs, or dependencies. New features won't be added frequently.

⚠️ License

Distributed under Apache License 2.0 license. See LICENSE for more information.

🤝 Contact

Duong Vinh - @duckymomo20012 - [email protected]

Project Link: https://github.com/SE-COURSE-19CLC-FITUS/501recipe.

💎 Acknowledgements

Here are useful resources and libraries that we have used in our projects:

• Awesome Readme Template: A detailed template to bootstrap your README file quickly.