Skip to content

README.md

Latest commit

 

History

History
236 lines (161 loc) · 8.32 KB

README.md

File metadata and controls

236 lines (161 loc) · 8.32 KB

👋 Welcome to CodeNearby

License: MIT PRs Welcome Good First Issues Last Commit Contributors Open Issues Vercel Visitors

CodeNearby is a social networking platform built with Next.js 14, made specifically for developers to connect, collaborate, and grow together.

CodeNearby - Find coding partners & build together—Tinder for developers! | Product Hunt

🚀 Find coding partners. Build together. Think Tinder for developers.
🧑‍💻 Now open-source — contribute and grow with us!

🌐 Visit codenearby.space Now

📚 Table of Contents

🌟 Features

  • 🔍 Discover Developers: Search by skills, interests, and location
  • 🤖 AI-Connect: Find GitHub developers through natural conversation using Meta: Llama 4 Maverick AI
  • 💬 Chat: Real-time conversations and collaboration
  • 📢 Developer Feed: Share updates, snippets, and thoughts
  • 🎭 Virtual Gatherings: Host anonymous polls, events & discussions
  • 🐙 GitHub Integration: Auto-fetch your profile and GitHub activity
  • 🌐 Global Meets Local: Interact worldwide, focus locally
  • ⚡ Redis Caching: Fast responses with Upstash Redis caching for GitHub searches and AI interactions

⚙️ Tech Stack

  • Framework: Next.js 14
  • Database: MongoDB
  • Auth: NextAuth.js (GitHub provider)
  • Storage: Cloudinary
  • Realtime + Notifications: Firebase
  • AI: Meta: Llama 4 Maverick AI for intelligent developer search
  • Caching: Upstash Redis for efficient API and AI caching

🚧 .env Configuration

Create a .env.local file in the root and paste the following:

NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=your_secret_here

GITHUB_ID=your_github_id_here
GITHUB_SECRET=your_github_secret_here

MONGODB_URI=mongodb://localhost:27017
NODE_ENV=development

CLOUDINARY_CLOUD_NAME=your_cloud_name
CLOUDINARY_API_KEY=your_api_key
CLOUDINARY_API_SECRET=your_api_secret

NEXT_PUBLIC_FIREBASE_DATABASE_URL=
NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_FIREBASE_PROJECT_ID=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSENGER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=

# Google Gemini API
GOOGLE_GENERATIVE_AI_API_KEY=your_gemini_key

# Upstash Redis configuration for caching
UPSTASH_REDIS_REST_URL=your_upstash_redis_url
UPSTASH_REDIS_REST_TOKEN=your_upstash_redis_token

🔑 How to Get the Required Credentials

  • GitHub OAuth (NextAuth)
    → GitHub Developer Settings → Register a new OAuth App
    → Homepage URL: http://localhost:3000
    → Callback URL: http://localhost:3000/api/auth/callback/github

  • MongoDB URI
    → Use MongoDB Atlas or local MongoDB
    → Example: mongodb+srv://<username>:<password>@cluster.mongodb.net/CodeNearby

  • Cloudinary
    → Sign Up → Dashboard → Get Cloud Name, API Key & Secret

  • Firebase Config
    → Firebase Console → Create project
    → Go to Project Settings → Web App → Copy config variables into .env.local

  • Gemini API Key → Google AI Studio → Get API Key for Gemini AI

  • Upstash Redis → Sign Up for Upstash → Create a new Redis database → Copy the REST URL and REST Token into .env.local

🧠 Why CodeNearby?

  • Find devs who share your stack & mindset
  • Use AI-powered search to discover the perfect collaborators
  • Connect with people around you, virtually or IRL
  • Build real technical relationships
  • Share your coding journey
  • Stay updated with local meetups & events

🛠️ Getting Started (Local Development)

git clone https://github.com/subh05sus/codenearby.git
cd codenearby
npm install
cp .env.example .env.local # then fill it with your credentials
npm run dev

🤝 Contributing to CodeNearby

We welcome all contributions — from bug fixes to new feature ideas. Whether you're improving UI, fixing typos, or optimizing performance, you're helping the community.

📌 Steps to Contribute

  1. Fork the repository

  2. Clone your fork locally:

    git clone https://github.com/subh05sus/codenearby.git
cd codenearby

  3. Create a new feature branch:

    git checkout -b feature/your-feature-name

  4. Make your changes and commit them:

    git commit -m "feat: add your feature"

  5. Push to your fork and create a Pull Request:

    git push origin feature/your-feature-name

  6. Submit your PR to the main branch with a clear description.

💡 Pro tip: Please follow our PR template and ensure your branch is updated with main before requesting review.

💡 Contributors

📌 Our Vision

Networking for developers should be effortless.
Whether you're looking for a mentor, co-founder, or hackathon buddy, CodeNearby makes it simple and personal.

🛤️ Roadmap & Future Plans

  • Real-time chat integration
  • More Advanced AI matchmaking
  • Mobile app support (React Native)
  • Event scheduling and calendar sync
  • Video chat integration for real-time collaboration
  • Localization and multi-language support

❓ FAQ

Q: Is CodeNearby free to use?
A: Yes, it’s fully open-source and free.

Q: Can I self-host CodeNearby?
A: Absolutely. Follow the setup instructions and you’re good.

Q: How does AI-Connect protect my data?
A: We only use your public GitHub data and process AI requests securely with Google Gemini API.

Q: Can I contribute without coding?
A: Yes! You can help by reporting bugs, suggesting features, or improving docs.

🌍 Join the Movement

Let's make the developer community stronger, more collaborative, and accessible — together.

⭐ Star this repo | 🍴 Fork it | 🤝 Contribute

📣 Find us on

🆘 Need Help?

  • Join the GitHub Discussions for community support
  • Open an issue for bugs or feature requests
  • Contact Subhadip directly for inquiries

Built with ❤️ by Subhadip and the awesome contributors.