Skip to content

JawwadK/twxt

Repository files navigation

Twxt

Status GitHub License Next.js React Tailwind CSS

🐦 A modern Twitter-like social platform built with Next.js and React

📋 Features

👤 User Management

  • User authentication system
  • Customizable user profiles
  • Follow/unfollow functionality
  • Personal avatar system
  • Bio and website links

📝 Post System

  • Create and share posts (tweets)
  • Support for text content
  • Image upload and preview
  • Character limit with counter
  • Rich text links detection

💬 Interaction System

  • Like/unlike posts
  • Comment on posts
  • View user profiles
  • Real-time character counting
  • Expandable comment sections

🎨 UI/UX Features

  • Dark/Light mode toggle
  • Responsive design
  • Modern card-based layout
  • Smooth animations
  • Clean and intuitive interface

🚀 Getting Started

Prerequisites

  • Node.js 18.0.0 or higher
  • npm or yarn
  • Git

Installation

  1. Clone the repository
git clone https://github.com/yourusername/twxt.git
cd twxt
  1. Install dependencies
npm install
# or
yarn install
  1. Run the development server
npm run dev
# or
yarn dev
  1. Open http://localhost:3000 with your browser

🛠 Tech Stack

  • Framework: Next.js 14
  • Frontend Library: React 18
  • Styling: Tailwind CSS
  • UI Components: shadcn/ui
  • Icons: Lucide Icons
  • State Management: React Hooks
  • Storage: Local Storage
  • Fonts: Geist Font Family

📂 Project Structure

twxt/
├── public/          # Static files
├── src/
│   ├── app/        # Next.js app directory
│   ├── components/ # React components
│   │   ├── auth/   # Authentication components
│   │   ├── layout/ # Layout components
│   │   ├── profile/# Profile components
│   │   ├── tweet/  # Tweet components
│   │   └── ui/     # UI components
│   ├── hooks/      # Custom React hooks
│   ├── lib/        # Utility functions
│   └── types/      # TypeScript types
└── styles/         # Global styles

💡 Key Features Details

Post Creation

- Rich text input with character limit
- Image upload with preview
- Client-side URL detection
- Keyboard shortcuts (Cmd/Ctrl + Enter to post)

User Profile

- Customizable display name
- Bio with character limit
- Location and website fields
- Following/Followers count
- Personal tweet collection

Interaction System

- Like/Unlike animations
- Nested comments
- User mentions
- Profile navigation

🎯 Future Enhancements

  • Real-time updates
  • Media gallery
  • Direct messaging
  • Hashtag system
  • Search functionality
  • Bookmarks
  • Analytics
  • Mobile app

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

📞 Support

If you need help with the application, feel free to:

  • Open an issue on GitHub
  • Send a pull request
  • Contact the developer

Made with ❤️ by [Your Name]

About

Quick mockup twitter clone made with react

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published