https://github.com/nating/penpal

Connect with real humans to practice your target language
https://github.com/nating/penpal

Last synced: 10 months ago
JSON representation

Connect with real humans to practice your target language

• Host: GitHub
• URL: https://github.com/nating/penpal
• Owner: nating
• Created: 2025-03-27T14:36:44.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-09T11:28:24.000Z (about 1 year ago)
• Last Synced: 2025-05-18T00:11:35.061Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 276 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  



Penpal




  The real-human language exchange matching app











---

## Overview

Penpal is a mini app that helps you connect with **real humans** who speak your *target language*, so you can **practice** and **improve** together. Our matching algorithm ensures you're paired with the right person, and you can chat safely through the World app – making it easy to find genuine partners for language exchange.

**Features include**:

- **One-click matching**: Just select your language and your target partner’s language, and the app does the rest.  

- **Secure sign-in** with World – ensures you're talking to real people, not bots.  

- **Lightweight** UI with quick, minimal transitions.  

- **Cancel** or **Delete** your match easily if you're no longer interested.  

- **“Start Chat”** button for direct conversation once matched.

---

## How It Works

1. **Sign In with World**  

   - Verifies that you’re a real human and fetches your World username.  

2. **Request a Penpal**  

   - Select your current language and the language you wish to learn.  

   - The app searches for a suitable partner who wants to learn your language.  

3. **Get Matched**  

   - Once a match is found, you’ll see their username – plus an option to start chatting.  

4. **Build Your Skills**  

   - Practice your target language with a real human partner.  

   - If you want a new partner, remove the old match and request again.

---

## Tech Stack

- **[Next.js 15](https://nextjs.org/)** – App Router  

- **[Tailwind CSS](https://tailwindcss.com/)** – for styles and utility classes  

- **[Supabase](https://supabase.com/)** – data storage (penpal requests, matching info)  

- **[MiniKit (World App)](https://developer.world.org/)** – secure real-human verification & incognito actions  

---

## Contributing

We welcome contributions! Feel free to open issues for feature requests, bug reports, or general improvements. Submit a PR, and we’ll review it as soon as possible.

**Steps to Contribute:**

1. Fork this repository.

2. Create a feature branch.

3. Commit your changes with clear commit messages.

4. Submit a Pull Request.

Please ensure all commits pass our lint checks and do not break existing tests.

## License

[MIT License](./LICENSE)

**© 2025 Penpal** – connect with real humans, learn new languages faster.