An open API service indexing awesome lists of open source software.

https://github.com/yntpdotme/chirp

Emoji-only social network for Gen-Z.
https://github.com/yntpdotme/chirp

clerk nextjs prisma social-media t3-stack trpc upstash

Last synced: about 2 months ago
JSON representation

Emoji-only social network for Gen-Z.

Awesome Lists containing this project

README

          

Chirp


The Emoji-Only Social Network built for Gen-Z.


Jio Network blocking the view? Network switch reveals the magic!

[![Twitter Badge](https://img.shields.io/badge/-@yntpdotme-1ca0f1?style=social&labelColor=red&logo=x&logoColor=black&link=https://twitter.com/yntpdotme)](https://twitter.com/yntpdotme)  [![Linkedin Badge](https://img.shields.io/badge/@yntpdotme-0e76a8)](https://www.linkedin.com/in/yntpdotme/)  [![Mail Badge](https://img.shields.io/badge/-hello@yntp.me-c0392b?style=flat&labelColor=c0392b&logo=gmail&logoColor=pink)](mailto:hello@yntp.me)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)  [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

 [See it in Action](https://chirp-yntp.vercel.app)  »



Introduction
· Features
· Tech Stack
· Development Setup
· Contributing


## ❄️ Introduction

Chirp is the emoji-only social app where vibes speak louder than words. No texts, no captions — just pure emotion in every post. Chirp lets you react, express, and connect without saying a thing. Say it all. Just Chirp it.




Jio Network blocking the view? Network switch reveals the magic!




## 🔋  Features

-  📦   End-to-End TypeSafe APIs

-  🎚️   Rate Limiting per user

-  🗃️   Organized File and Folder Structure

-  🔑   Secure Authentication with OAuth Providers (Google & GitHub)

-  📱   Fully Responsive Design optimized for all devices

-  ☾   Light and Dark Mode


## ⚙️  Tech Stack

- [tRPC](https://trpc.io/) - TypeSafe RPC

- [Next.js](https://nextjs.org/) – React Framework

- [Upstash](https://upstash.com/) - Rate Limiting

- [ShadCN UI](https://ui.shadcn.com/) – Component library

- [Tailwind CSS](https://tailwindcss.com/) – CSS

- [TypeScript](https://www.typescriptlang.org/) - TypeSafe JavaScript

- [Zod](https://zod.dev/) - Schema Declaration & Validation Library

- [Postgres](https://www.postgresql.org/) - Database

- [Prisma](https://prisma.io/) – ORM

- [Clerk](https://clerk.com/) – Authentication

- [Git](https://git-scm.com) – Versioning

- [Vercel](https://vercel.com) – Deployments


## 🖥️   Local Development

0. **Prerequisites**

Make sure you have the following installed on your machine:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en) (v20+)
- [Docker](https://www.docker.com/)
- [bun](https://bun.sh/) (As a Package Manager)

1. **Clone the repository:**

```bash
git clone https://github.com/yntpdotme/chirp.git
```

2. **Navigate to the project directory:**

```bash
cd chirp
```

3. **Install dependencies:**

```bash
bun install
```

4. **Add Environment Variables:**

Create `.env` file in the root folder and copy paste the content of `.env.sample`

```bash
cp .env.sample .env
```

Update credentials in `.env` with your credentials.

5. **Setup Database**

Start Postgres with Docker

```bash
./start-database.sh
```

6. **Start the App:**

```bash
bun dev
```

Visit  [http://localhost:3000](http://localhost:3000)  to access your app.


## 🤝  Contributing

Contributions are always welcome!

See [CONTRIBUTING.md](./CONTRIBUTING.md) for ways to get started.

## 🪪   License

Chirp is open-source under the [MIT License](./LICENSE).
Feel free to learn, add upon, and share!