# Chirpy | [简体中文](./README-zh.md)

[![Vercel](https://img.shields.io/github/deployments/devrsi0n/chirpy/production?logo=vercel)](https://github.com/devrsi0n/chirpy/deployments)
[![Twitter Chirpy](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FChirpyHQ)](https://twitter.com/ChirpyHQ)

<img src="https://raw.githubusercontent.com/devrsi0n/chirpy/main/apps/main/public/images/marketing/github.png" width="800" alt="Comment widget" >

👋 [Chirpy](https://chirpy.dev) is a privacy-friendly and customizable Disqus(comment system) alternate. Try it now: [Playground](https://chirpy.dev/play).

<details>
    <summary>More screenshots</summary>
    <img src="https://raw.githubusercontent.com/devrsi0n/chirpy/main/apps/main/public/images/blog/open-source/theme.png" width="800" alt="Widget theme" >
    <img src="https://raw.githubusercontent.com/devrsi0n/chirpy/main/apps/main/public/images/blog/open-source/analytics.png" width="800" alt="Widget analytics" >
    <img src="https://raw.githubusercontent.com/devrsi0n/chirpy/main/apps/main/public/images/docs/features/theme/dashboard.png" width="800" alt="Project dashboard" >
    <img src="https://raw.githubusercontent.com/devrsi0n/chirpy/main/apps/main/public/images/docs/get-started/integration-guide.png" width="800" alt="Widget integration guide" >
    <img src="https://raw.githubusercontent.com/devrsi0n/chirpy/main/apps/main/public/images/docs/features/privacy-friendly/anonymous-sign-in.png" width="800" alt="Anonymous sign-in" >
    <img src="https://raw.githubusercontent.com/devrsi0n/chirpy/main/apps/main/public/images/docs/features/notifications/site-notification.png" width="800" alt="Site notification" >
    <img src="https://raw.githubusercontent.com/devrsi0n/chirpy/main/apps/main/public/images/docs/features/anti-toxic-comment/example.png" width="800" alt="Anti toxic comment" >
</details>

<br>

Like what you see? Give Chirpy a GitHub Star ⭐, it will help us a lot!

## ✨ Key features

- 🔒 Privacy-friendly
- 🎨 [Customizable widget](https://chirpy.dev/docs/features/theme)
- ✍️ Rich Text Formatting & [Markdown shortcuts](https://chirpy.dev/docs/features/markdown)
- 📊 [Widget analytics](https://chirpy.dev/docs/features/analytics)
- 🪄 Real-time comments
- 📱 Mobile friendly
- 🔔 [Email & Web push notifications](https://chirpy.dev/docs/features/notifications)
- 🤐 [Anti-toxic comment](https://chirpy.dev/docs/features/anti-toxic-comment)
- 💬 [Comment moderation](https://chirpy.dev/docs/features/moderation)
- 🎭 [Anonymous sign-in](https://chirpy.dev/docs/features/privacy-friendly#anonymous-sign-in)
- 📬 [Email/magic link sign-in](https://chirpy.dev/docs/features/privacy-friendly#email-sign-in)

## 🧭 Roadmap

Although Chirpy is ready to serve you and your users, we're working hard to add more features:

- More custom options
- ~~Account plan~~
- ~~Payment~~

## 🍡 Tech stacks

- [![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
- [![Next.js](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)](https://nextjs.org/)
- <img src="https://trpc.io/img/logo.svg" width="50" alt="tRPC logo" />
- <img src="https://www.prisma.io/images/apple-touch-icon.png" width="50" alt="Prisma logo" />
- [![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/)
- [![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)](https://jestjs.io/)
- [next-auth](https://github.com/nextauthjs/next-auth)
- [tiptap](https://tiptap.dev)
- [Tinybird](https://www.tinybird.co)

## 🥇 Contribution

You're welcome to contribute to this project. Please follow the [CONTRIBUTING](CONTRIBUTING.md) guide.

## 🚀 Hosting platforms

[![Powered by Vercel](https://raw.githubusercontent.com/abumalick/powered-by-vercel/master/powered-by-vercel.svg)](https://vercel.com?utm_source=chirpy.dev)

## 💅 Design system

- Colors come from [radix color](https://www.radix-ui.com/colors)
- Home hero section is inspired by [stitches](https://stitches.dev/)

## ⚖️ License

AGPL 3.0

## More products from author

[![Quotion - Apple Notes to blogs in minutes](https://quotion.co/images/root/og-image.png)](https://quotion.co)