https://github.com/aryanrathore63/twitter_clone

https://github.com/aryanrathore63/twitter_clone

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/aryanrathore63/twitter_clone
• Owner: aryanrathore63
• Created: 2024-06-10T17:40:03.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-10T17:52:16.000Z (7 months ago)
• Last Synced: 2024-06-10T20:46:02.264Z (7 months ago)
• Language: JavaScript
• Size: 350 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MERN Stack Twitter Clone

This is a **Twitter Clone project** built using the **MERN** (MongoDB, Express.js, React, Node.js) stack. It includes features like authentication, posts, retweeting, and user registration with validation. Below, you'll find instructions on how to install and run the project.

### Features

**User Registration:** New users can sign up with unique usernames and emails.


**Authentication:** Secure login and logout functionality.


**Posts:** Users can create, view, and interact with posts. Posts are visible to unregistered users too, but to make post they you the authentication.


**Retweeting:** Share and retweet posts with ease.


### User Stories

```

As a new user

So that I can use Twitter

I want to be able to register for an account

As a registered user

So that I can interact with others on the platform

I want to be able to log in to my account

As a logged-in user

So that I can share my thoughts and updates

I want to be able to create and post messages (posts) on the platform

As a logged-in user

So that I can engage with content

I want to be able to view posts in reverse chronological order and who created them

As a logged-in user

So that I can engage with content

I want to have the option to retweet (share) posts

As a logged-in user

So that I can manage my account

I want to be able to log out of my account

As a logged-in user

So that I can engage with content

I want to be able to like (or upvote) posts

```

### Installation

Follow these steps to get the project up and running on your local machine:

Clone the Repository: Use the following command to clone the project repository to your local machine:

```

git clone  // Replace  with the actual URL of project's repository.

```

Install Server Dependencies: In the project directory, navigate to the server folder and run:

```

cd server

npm install

```

Install Client Dependencies: Navigate to the client folder and run:

```

cd client

npm install

```

Start Your Application: After all dependencies are installed, you can start your application. In the server and client folders, run server:

```

npm start

```

Access Your Application: Once both the server and client are running: 

```

Open a web browser and navigate to http://localhost:5000

```