Reddish Save

Simplified ‘reddit’ (popular social-media site) clone. Made using MERN stack.

Project README

Reddish - A Reddit Clone - MERN

Reddit clone (a social media site) made w/ MERN stack & Redux.

Demo

Deployed on Netlify (front-end) & Heroku (back-end)

Built using

Front-end

Back-end

  • Node.js - Runtime environment for JS
  • Express.js - Node.js framework, makes process of building APIs easier & faster
  • MongoDB - Database to store document-based data
  • Mongoose - MongoDB object modeling for Node.js
  • Cloudinary - For image uploading & related API
  • JSON Web Token - A standard to secure/authenticate HTTP requests
  • Bcrypt.js - For hashing passwords
  • Validator.js - For validation of JSON data
  • Mongoose Unique Validator - Plugin for better error handling of unique fields within Mongoose schema
  • Dotenv - To load environment variables from a .env file

Features

  • Authentication (login/register with username-password)
  • CRUD posts & comments
  • Add posts in the form of text, link or image
  • Upvote/downvote posts & comments
  • Dynamic URLs for users (u/Aman) & subreddits (r/reactjs)
  • Sorting of posts on basis of algorithms like hot, top, controversial etc.
  • Full database search feature
  • Pagination of posts
  • Error management to prevent app crashes
  • Sort comments by oldest, newest, most upvoted etc.
  • Avatar uploading for user profiles
  • Toast notifications for actions: adding posts, deleting comments etc.
  • Loading spinners for relevant fetching processes
  • Dark mode toggle w/ local storage save
  • Responsive UI for all screens

Screenshots

Desktop/Tablet

Desktop-home Desktop-2 Desktop-3

Mobile

Mobile-home Mobile-2 Mobile-3 Mobile-4 Mobile-5

Usage

Notes:

  • For image API, make account at cloudinary.com & get API keys from account dashboard.
  • For upload preset usage, if you want to organize images separately at cloudinary.com, you have to create it from account settings first. If you don't want to, just don't put anything or use .env key - UPLOAD_PRESET.

Env variable:

Create .env file in server directory and add the following:

MONGODB_URI = "Your Mongo URI"
PORT = 3005
SECRET = "Your JWT secret"
CLOUDINARY_NAME = "From your cloudinary dashboard"
CLOUDINARY_API_KEY = "From your cloudinary dashboard"
CLOUDINARY_API_SECRET = "From your cloudinary dashboard"
UPLOAD_PRESET = "Folder/preset name from your cloudinary account" (OPTIONAL)

Client:

Open client/src/backendUrl.js & change "backend" variable to "http://localhost:3005"

cd client
npm install
npm start

Server:

Note: Make sure that you have installed 'nodemon' as global package.

cd server
npm install
npm run dev
Open Source Agenda is not affiliated with "Reddish" Project. README Source: amand33p/reddish

Open Source Agenda Badge

Open Source Agenda Rating