X-clone

Table of Contents

• Features
• Tech Stack
• Installation
• Usage
• API Endpoints
• Contributing
• License

Features

• User Authentication: Sign up, log in, and manage your account.
• Tweet Management: Create, edit, delete, and view tweets.
• Follow System: Follow and unfollow other users.
• Responsive Design: Fully responsive UI for a seamless experience on all devices.

Tech Stack

• Frontend: React, Redux, Tailwind CSS
• Backend: Node.js, Express.js
• Database: MongoDB, Mongoose

Installation

Prerequisites

• Node.js (v14 or later)
• MongoDB (local or Atlas)

Backend Setup

1. Clone the repository:

   git clone https://github.com/meeravanathi/X-clone.git
   cd X-clone

2. Navigate to the backend directory and install dependencies:

   cd server
   npm install

3. Create a .env file in the backend directory with the following environment variables:

   MONGO_URI=your_mongodb_connection_string
   JWT=your_jwt_secret

4. Start the backend server:

   npm start

Frontend Setup

1. Navigate to the frontend directory and install dependencies:

   cd client
   npm install

2. Start the frontend development server:

   npm start

The application should now be running at http://localhost:3000 (for the frontend) and http://localhost:8000 (for the backend).

Usage

• Register: Create a new account or log in if you already have one.
• Create Tweet: Post new tweets and interact with others' tweets.
• Follow Users: Find and follow users to see their tweets in your timeline.
• Notifications: Stay updated with real-time notifications.

API Endpoints

Authentication

• POST /api/auth/signup - Register a new user
• POST /api/auth/signin - Log in an existing user

Tweets

• GET /api/tweets - Get all tweets
• POST /api/tweets - Create a new tweet
• PUT /api/tweets/:id - Edit a tweet
• DELETE /api/tweets/:id - Delete a tweet

Users

• GET /api/users/:id - Get user profile
• POST /api/users/follow/:id - Follow a user
• POST /api/users/unfollow/:id - Unfollow a user

Contributing

We welcome contributions to improve this project. Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature/your-feature).
5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

ChatGP

SIGNIN/SIGNUP PAGE

EXPLORE PAGE

EDIT PROFILE

PROFILE PAGE