README.md

CouponJars

CouponJars is a platform that allows users to submit and share their finds about coupon and deals to other users.
View Demo »

Frontend client Source Code · Backend server Source Code

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Features

CouponJars is a platform that allows users to submit and share their finds about coupon and deals to other users.

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Features

• User Signup
• User Login
• create post
• "Like" user's post
• Comment on user's post
• Change user password
• Change user display name/alias
• Coupon details page

(back to top)

Installation

1. Clone the repo

   git clone https://github.com/ChiShingLi/CouponJars.git

2. Install NPM packages

   npm install

3. Enter your API secrets in the .env file

   • FrontEnd Client:

   REACT_APP_DATABASE_URL = "ENTER YOUR MONGODB DATABASE URL";

   • Backend Client:

   PORT = "ENTER YOUR MONGODB DATABASE PORT NUMBER";
   
   DB_PATH = "ENTER YOUR MONGODB DATABASE CONNECTION STRING";
   
   JWT_SECRET = "ENTER YOUR JSON WEB TOKEN SECRET KEY";

(back to top)