Welcome all to open source 🚀

📃 Table of Contents

1. About desiTwitter
2. Want to Contribute?
3. Prerequisites
4. Tech Stack Used
5. Preview
6. License
7. Code of Conduct

🙌 About desiTwitter

Welcome to desiTwitter, a web application designed to recreate the experience of the popular social media platform, Twitter. This project aims to provide an interactive and user-friendly environment for sharing thoughts, updates, and engaging with a community of users. Whether you're a developer looking to explore the codebase or a user ready to join the conversation, we're excited to have you here!

*** Features ***

• Real-time Feeds: Stay up-to-date with the latest tweets and updates in real time, just like - the real Twitter.

• Tweeting and Retweeting: Share your thoughts, retweet interesting posts, and join the - conversation.

• Likes & Comments: Like or Comment on your favourite tweets and keep the conversation alive.

• Bookmarks: Bookmark your favourite tweets and revisit them later.

• Trending Topics: Discover what's trending and join the most popular discussions.

• Responsive Design: Enjoy a seamless experience on both desktop and mobile devices.

💈 Want to Contribute?

We welcome contributions to enhance this project. If you have ideas for improvements, bug fixes, or new features, please feel free to create an issue or submit a pull request.

To submit a PR, please follow these steps:

1. Star ⭐ and Fork the Project
2. Clone your forked repository

git clone https://github.com/YOUR-USERNAME/desiTwitter.git

3. Run the following command to change the working directory

cd desiTwitter

4. Run the following commands to install all the dependencies for the client and server:

cd client
npm install

cd ../server
npm install

5. Running the Application

• Client: To start the React client, navigate to the client directory:

cd client

Start the development server:

npm start

The client will be available at http://localhost:3000.

• Server: To start the server, navigate to the server directory:

cd server

Start the server:

npm start

The server will run on http://localhost:5000.

6. Now go ahead and create a new branch and move to the branch

git checkout -b <branch-name>

7. After you have added your changes, follow the following command chain Check the changed files

git status -s

8. Add all the files to the staging area

git add .

9. Commit your changes (add decent message )

git commit -m "<EXPLAIN-YOUR_CHANGES>"

10. Push your changes

git push origin <branch-name>

11. Open a Pull Request

• Make a pull request! (compare your branch with the owner main branch)

🧾 Prerequisites

Before starting out, you'll need to install the following on your computer.

⚡ Tech Stack Used

👀 Preview

📜 License

This Community is Licensed under MIT license.

🧧 Code of Conduct

Check out Code of Conduct to know inclusive environment that respects all contributions.

We value an inclusive environment that respects all contributions. To ensure a positive experience for everyone, please review our Code of Conduct.

---