Skip to content

Latest commit

 

History

History
162 lines (114 loc) · 7.4 KB

README.md

File metadata and controls

162 lines (114 loc) · 7.4 KB
Raw

Instagram_Clone

Table of Contents

General Info

The main aim of the project is to develop a web-based application using MERN Stack ,which works exactly like Instagram and also in future we can add many more options which are not present in Instagram .

In this we are also creating post recommendation app and that will help the user according to there preferences.

  • In this user can create and delete there post
  • It also provide good authentication so that the legitimate user can use this app
  • Backend using Mongodb

At present, only the frontend and Backend of the website has been developed, which consists of the landing page,sign-in and sign-up and createpost and profile page.

Features :

  • Login/Signup User Account
  • Login using Email/Username
  • Update Profile/Password User Account
  • Reset Password Mail using Sendgrid
  • Search User Accounts by Name/Username
  • Follow/Unfollow Users
  • Like/Unlike Posts (Double Tap Like)
  • Comment on Post
  • Save/Unsave Post
  • Visit User Profiles
  • Delete Own Posts
  • See Followers/Following of Users
  • Post Liked by Users

Features to implement in future:

  • Recommendation System using UnSupervised Learning
  • Message users
  • Infinite Scroll Posts
  • Google ,Facebook OAuthentication
  • Suggested Users
  • Skeleton Loaders
  • Search Users to Chat
  • Add New Chat
  • Message Users
  • Typing | Online User Status
  • Emoji Enabled (Emoji Mart)

Tech Stack Used:

Frontend:

reactjs  react-router  redux  tailwindcss  mui 

Backend:

nodejs  expressjs  mongodb  jwt 

Cloud Storage: Cloudinary

Mail Service: Sendgrid

Prerequisite to run the project in your desktop

It is recommended that your laptop should have the following specifications in order to run this project:

  • NodeJs
  • npm
  • Visual Studio Code (or any other IDE)
  • git

Steps to run the project:

  1. Clone the project using git clone command in terminal
    • git clone https://github.com/VGandhi27/Instagram_Clone.git
  2. Open the Instagram_Clone folder in Visual Studio Code (or any other IDE)
  3. In the terminal section of the Visual Studio Code run the following command
    • npm i - It will install all the node modules/libraries to run this WebApp
  4. Now run the following command
    • cd server npm start - It will start the server
    • cd client npm start - It will host the project in to a local server

Live Project link

Deployed Soon

📬 Contact

If you want to contact me, you can reach me through below handles.

  Linkedin Badge  

Show some ❤️ by starring this repository!

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify