Tweeter is a Twitter clone project that aims to push the boundaries of what can be achieved using React and Firebase. It replicates the core functionalities of Twitter, allowing users to tweet, retweet, like, comment, follow other users, search for tweets and users, receive notifications, and bookmark tweets. The project utilizes React, Tailwind CSS, Firebase, and Vite.
Check out the live demo of Tweeter: Tweeter Demo
To work on this project locally, you'll need the following dependencies:
-
Node.js: Make sure you have Node.js installed on your machine.
-
IDE: We recommend using Visual Studio Code (VSCode) as your code editor, but you can use any IDE of your choice.
-
Git Bash: Install Git Bash, a command-line tool for version control.
To start working on the Tweeter project, follow these steps:
-
Clone the repository: Open Git Bash or your preferred terminal and run the following command:
git clone https://github.com/GeneralAike/twitter-clone-reactjs.git
-
Change directory: Navigate into the project directory using the following command:
cd twitter-clone-reactjs
-
Install dependencies: Run the following command to install all the required dependencies:
npm ci
-
Create a branch: It is recommended to create your own branch to work on new features or bug fixes. Use the following command to create a new branch:
git checkout -b my-feature-branch
-
Start the development server: Run the following command to start the development server:
npm run dev
This will open the application in your default browser, and you can start working on the project.
Tweeter includes the following features:
- Tweet: Users can create and post tweets.
- Retweet: Users can retweet other users' tweets.
- Like: Users can like tweets.
- Comment: Users can comment on tweets.
- Notifications: Users receive notifications for likes and comments on their tweets.
- Follow: Users can follow other users.
- Search: Users can search for tweets and other users.
- Bookmark: Users can bookmark tweets.
The project aims to replicate most of the functionalities available on the actual Twitter platform.
Contributions are welcome! If you'd like to contribute to Tweeter, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and test them thoroughly.
- Commit your changes and push them to your forked repository.
- Open a pull request with a detailed description of your changes.
Please ensure that your contributions align with the project's coding standards and guidelines.
The Tweeter project is licensed under the MIT License.
If you have any questions or feedback regarding Tweeter, feel free to reach out to us at emmanese2020@gmail.com.