https://github.com/aelkayam/quackker

A simple Twitter clone - text only, login via Discord/Google/Github
https://github.com/aelkayam/quackker

nextjs planetscale prisma t3-stack vercel

Last synced: 14 days ago
JSON representation

A simple Twitter clone - text only, login via Discord/Google/Github

• Host: GitHub
• URL: https://github.com/aelkayam/quackker
• Owner: aelkayam
• License: mit
• Created: 2024-02-24T14:15:06.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-05T21:05:49.000Z (9 months ago)
• Last Synced: 2024-10-11T01:43:45.405Z (about 1 month ago)
• Topics: nextjs, planetscale, prisma, t3-stack, vercel
• Language: TypeScript
• Homepage: https://quackker.vercel.app
• Size: 325 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Quackker (Twitter Clone)

Welcome to Quackker! Quackker is a Twitter-like social media web application built using Next.js, React, Tailwind CSS, Prisma, tRPC, and TypeScript.

## Features

- **User Authentication**: Users can log in, and securely authenticate their accounts using Discord/Google/GitHub.

- **Create and Share Quacks**: Users can write and share quacks (tweets) with the public.

- **Global Feed and Personal Feed**: Users can follow other users just like in twitter.

- **Like Quacks**: Users can express their appreciation for quacks by liking them.

## Tech Stack

- **Next.js**: Enables server-side rendering and web app development.

- **React**: Powers dynamic user interfaces.

- **Tailwind CSS**: streamlined UI styling.

- **Prisma**: Simplifies database access and schema management.

- **tRPC**: Builds robust TypeScript APIs.

- **TypeScript**: Enhances codebase reliability and maintainability.

## Usage

To use Quackker, simply visit the following URL: [Quackker Website](https://quackker.vercel.app/)

## Getting Started

To get started with Quackker locally, follow these steps:

1. Clone the repository:

   `git clone https://github.com/aelkayam/quackker.git`

2. Navigate to the project directory:

   `cd quackker`

   

3. Install dependencies:

    `npm install`

    or

    `yarn install`

   

4. Set up environment variables:

   

   - Copy the `.env.example` file and rename it to `.env`.

   - Fill in the necessary environment variables such as database credentials and API keys.

5. Run the development server:

    `npm run dev`

    or

    `yarn dev`

   

6. Open your web browser and navigate to `http://localhost:3000` to view Quackker locally.

## Contributing

Contributions to Quackker are welcome! Feel free to open issues and pull requests for bug fixes, enhancements, or new features.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

Happy Quacking! 🦆🎉