Twitter App

A social media application built with the MERN stack. Inspired by Twitter, it enables users to create and delete posts, view others' posts, follow and unfollow users, like and comment on posts, manage user profiles, and receive notifications.

Table of Contents

• Features
• Technologies Used
• Installation
• Usage
• Contributing
• License
• Contact

Features

• Create and delete posts
• View posts from other users
• Follow and unfollow users
• Like and comment on posts
• Manage user profiles
• Receive notifications

Technologies Used

• Node.js
• TypeScript
• MongoDB
• React.js
• Mongoose
• Express.js
• Cloudinary
• TailwindCSS
• DaisyUI
• TanStack Query
• React Hot Toast

Installation

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

1. Clone the repository

   git clone https://github.com/JoshuaOzorji/twitter-app.git

2. Navigate to the project directory

   cd twitter-app

3. Install dependencies for the server

   cd server
   npm install

4. Install dependencies for the client

   cd ../client
   npm install

5. Set up environment variables Create a .env file in the server directory and add the necessary environment variables. Refer to .env.example for the required variables.

6. Run the application

   • Start the server:

     cd server
     npm start

   • Start the client:

     cd ../client
     npm start

Usage

Once the application is running, you can:

• Sign up and log in to your account
• Create, edit, and delete posts
• View posts from other users
• Follow and unfollow users
• Like and comment on posts
• Manage your profile
• Receive real-time notifications

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

Joshua Ozorji - Website - ozorjijoshua@gmail.com

Project Link: https://github.com/JoshuaOzorji/twitter-app