Skip to content

Latest commit

 

History

History
120 lines (85 loc) · 3.6 KB

README.md

File metadata and controls

120 lines (85 loc) · 3.6 KB

Threads Clone Logo

Threads Clone

A social media platform built with React.js, Node.js, Express.js, MongoDB, and more!

GitHub stars GitHub forks GitHub issues

Features • Technologies • Installation • Usage • Contributing •

Features

Experience the power of Threads Clone with these exciting features:

  • 🔐 Authentication and Authorization: Secure your app with JWT-based user authentication and authorization.

  • 📝 Create Posts with Images: Share your thoughts and moments with the world, including captivating images.

  • ❌ Delete Posts: Have full control over your content; remove posts when needed.

  • 🔄 Update User Profile: Keep your profile information up to date effortlessly.

  • ❤️ Like/Unlike a Post: Express your appreciation for posts with likes and easily change your mind.

  • 💬 Reply To a Post: Engage in meaningful discussions by responding to posts.

  • 🔗 Follow/Unfollow Users: Stay connected with friends and discover new people; manage your social network effortlessly.

  • 🌓 Dark/Light Mode: Customize your experience with a dark or light mode switch.

Technologies

🚀 React.js - Frontend UI
🌐 Node.js - Backend server
⚡ Express.js - Web application framework
📦 MongoDB - Database for storing data
🎨 Chakra UI - Modern UI components
☁️ Cloudinary - Image uploads and storage
🔄 Recoil - State management for React

Installation

  1. Clone the repository:
git clone https://github.com/your-username/threads-clone.git
cd threads-clone
  1. Install the dependencies for both the frontend and backend:
# Install frontend dependencies
cd frontend
npm install

# Install backend dependencies
cd ../backend
npm install
  1. Set the environment variables for backend
PORT=5000
MONGO_URI=
JWT_SECRET=
CLOUDINARY_CLOUD_NAME=
CLOUDINARY_API_KEY=
CLOUDINARY_API_SECRET=

Usage

cd frontend
npm run dev

cd backend
npm run dev

Open your browser and navigate to http://localhost:3000 to view the application.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing something, feel free to open an issue to discuss it, or directly create a pull request with the necessary changes.
  • Create individual PR for each suggestion.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request