Home

Welcome to the CodeNearby Wiki

CodeNearby is a developer-focused social networking platform designed to help you find collaborators, build projects, and grow your tech network. This wiki serves as a living knowledge base to guide development, contribution, and collaboration.

---

Project Structure Overview

Here’s a high-level breakdown of the directory structure to help you locate components, APIs, and configurations quickly.

📁 .github/

Contains GitHub-specific project configurations:

• ISSUE_TEMPLATE/

  • bug_report.md
  • docs-feedback.md
  • feature_request.md
  • performance-issue.md
  • ui-suggestion.md

• FUNDING.yml

• PULL_REQUEST_TEMPLATE.md

📁 .husky/

• Contains Git hook scripts (e.g. pre-push) for automation like changelog generation.

📁 app/

Houses Next.js 14 App Router structure with routes, API endpoints, and pages.

• API routes under /api/:

  • auth, developers, gathering, posts, profile, etc.

• Feature routes:

  • ai-connect, feed, explore, messages, onboarding, gathering, invite, profile, etc.

• Static content:

  • privacy, terms, about, etc.

• Shared layout files: layout.tsx, globals.css

📁 components/

Modular and reusable React components categorized by domain:

• home/, magicui/, ui/, onboarding/, reactbits/
• Shared UI: alerts, buttons, popovers, tooltips, cards, etc.
• Advanced widgets: AI chat, polls, location sharing, developer grids

📁 consts/, hooks/, lib/, utils/

• Constants (faq, changelog, basic app values)
• Custom hooks (e.g. use-auto-scroll)
• Utility functions for Redis, Firebase, MongoDB, AI, etc.

📁 types/

TypeScript type definitions (next-auth, votes, global types)

📁 public/

Static assets used throughout the app: logos, icons, images

---

Documentation Index

• Contributing Guide — Standards for PRs, issue triage, and local setup
• Contributor Guide — Project philosophy, environment setup, core values
• Code of Conduct — Behavior expectations and enforcement policy
• Security Policy — Reporting vulnerabilities and security best practices
• Troubleshooting Guide — Common issues and their resolutions
• Support Policy — What kind of help you can expect

---

Core Features

• AI-assisted dev matching
• GitHub-powered profiles
• Realtime chat & activity feed
• Virtual gatherings & polls
• Firebase notifications
• Cloudinary image storage
• Redis caching for speed

---

Deployment & Environment

All .env configuration is documented in the root README.md. Refer to .env.example for initial setup.

---

Contribution Workflow

• Use pull request template
• File issues under correct category: bug, feature, UI, performance
• Discuss major ideas before implementing via GitHub Discussions

---

Get Started

To clone and run locally:

git clone https://github.com/subh05sus/codenearby.git
cd codenearby
npm install
cp .env.example .env.local
npm run dev

---

Licensing

This project is licensed under MIT License. See details inside.