Skip to content

Latest commit

 

History

History
84 lines (61 loc) · 2.84 KB

README.MD

File metadata and controls

84 lines (61 loc) · 2.84 KB
Raw

📱 Social Media Platform

Welcome to the Social Media Platform project! This application allows users to connect, share content, and interact in a dynamic social space.

📸 Screenshots

Page

Page

Page

📋 Table of Contents

✨ Features

  • User Authentication: Sign up, log in, and password recovery options.
  • Profile Customization: Edit your bio, upload a profile picture, and more.
  • Post Sharing: Share text posts, images, and links with other users.
  • Real-time Notifications: Stay updated with live notifications.
  • Direct Messaging: Private chats with other users.
  • Commenting and Liking: Engage with posts through comments and likes.
  • Search: Find users and posts with a powerful search feature.

🛠️ Technologies

  • Frontend: React, Redux, Tailwind CSS
  • Backend: Node.js, Express, MongoDB
  • Real-time: WebSocket, Socket.IO
  • Authentication: JWT (JSON Web Tokens)
  • Deployment: Docker, AWS

⚙️ Installation

  1. Clone the repository:

    git clone https://github.com/infallibless/social-media-website.git
cd social-media-website

  2. Install dependencies:

    npm install
cd client
npm install

  3. Configure environment variables:

    • Create a .env file in the root directory.
    • Add the following keys: 
      MONGO_URI=your-mongodb-uri
JWT_SECRET=your-jwt-secret

  4. Start the server and client:

    # In the root directory
npm run dev

  5. Access the app in your browser at http://localhost:3000.

🧑‍💻 Usage

After installing and running the app, you can:

  1. Sign up and log in to create an account.
  2. Edit your profile to add personal details.
  3. Connect with other users, create posts, and leave comments.
  4. Explore trending topics through the search and discover features.

📜 Copyright

© 2024 raynex. All rights reserved.

All files in this repository, unless otherwise noted, are released under the MIT License. By using, distributing, or modifying this code, you acknowledge the copyright holder's rights and agree to retain this copyright notice in any redistribution.