Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 3.57 KB

README.md

File metadata and controls

102 lines (70 loc) · 3.57 KB
Raw

Profile Store | MERN

A MERN stack app for storing profile links of people you admire, at one place.

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 email-password)
  • Upload images for display pictures of contacts
  • Add/update/delete contacts & change display picture
  • Add/update/delete profile links of individual contacts
  • Search contacts by name or profile links
  • Toast notifications for actions - adding/updating/deleting contact, or welcome message etc.
  • Dark mode toggle w/ local storage save
  • Responsive UI for all screens

Screenshots

Desktop/Tablet Home

Home

Auth Forms

Auth Forms

Pop-up windows (modals)

Pop-up windows

Mobile UI

Mobile UI - 1

Mobile UI - 2

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