/twitterX

TwitterX is a Twitter clone application developed using the MERN (MongoDB, Express, React, Node.js) stack. It offers basic functionalities similar to Twitter, including user authentication, posting tweets, and viewing timelines.

Primary LanguageJavaScript

TwitterX

TwitterX is a Twitter clone application developed using the MERN (MongoDB, Express, React, Node.js) stack. It offers basic functionalities similar to Twitter, including user authentication, posting tweets, and viewing timelines.

Features

  • User Authentication (Sign Up, Login)
  • Post Tweets
  • View Timeline
  • Follow/Unfollow Users
  • Like/Retweet Posts

Project Structure

The project is divided into two main parts:

  1. Client: The frontend of the application built with React.
  2. Server: The backend of the application built with Node.js, Express, and MongoDB. System Design

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

  • Node.js
  • npm (Node Package Manager)
  • MongoDB

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/twitterx.git
    cd twitterx
    
  2. Setup the Client:

  • Navigate to the Client Directory :
    cd client
    
  • Install Dependencies :
    npm install
    
  • Start the Frontend :
    npm start
    
  1. Setup the Server:
  • Navigate to the Server Directory :
    cd server
    
  • Install Dependencies :
    npm install
    
  • Setup .env file :
    PORT=5000
    URL=MongoDB URL
    
  • Start the Frontend :
    nodemon server.js
    

Running the Application

  • Make sure both the frontend and backend servers are running.
  • Open your browser and navigate to http://localhost:3000 to see the application in action.

Contributing

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

  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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Sameer Shaik - sameer.kattubadi@gmail.com

Project Link: https://github.com/SSameer20/twitterX.git

Explanation

  • Project Overview: Provides a brief description and features of the project.
  • Project Structure: Explains the two main parts of the project: client and server.
  • Getting Started: Provides step-by-step instructions on how to clone the repository and set up both the client and server.
  • Running the Application: Instructions on how to run the