CodeWithAhsan

A community platform for mentorship, open-source project collaboration, learning roadmaps, and courses — built by Ahsan Ayaz.

---

Features

• Mentorship program — Apply to become a mentee, get matched with an accepted mentor
• Project collaboration — Submit open-source projects, recruit contributors, manage teams
• Learning roadmaps — Mentors publish structured learning paths; community members follow them
• Courses & content — MDX-based course posts, YouTube integration, and a blog
• Events / Promptathon — Live interactive events with presenter panels and winner display
• Discord integration — Automatic channel provisioning and role assignment on signup

Tech Stack

Layer	Technology
Framework	Next.js 16 (App Router, Turbopack)
UI	React 19, Tailwind CSS v4, DaisyUI
Language	TypeScript
Backend	Next.js API Routes (serverless)
Database	Firebase Firestore
Auth	Firebase Authentication
Storage	Firebase Storage
Testing	Vitest, @firebase/rules-unit-testing
Deployment	Vercel

---

Local Development Setup

Prerequisites

• Node.js 18+ — nodejs.org
• npm (comes with Node.js)
• Firebase CLI — npm install -g firebase-tools
• Java Runtime (JRE) — required by Firebase emulators (download)

Steps

1. Clone the repository

   git clone https://github.com/ahsanayaz/code-with-ahsan.git
   cd code-with-ahsan
   

2. Install dependencies

   npm install
   

3. Set up environment variables

   cp .env.example .env.local
   

   For local development with Firebase emulators, the default placeholder values in .env.local are sufficient — you do not need real Firebase credentials. See .env.example for documentation on each variable.

4. Start Firebase emulators

   npm run emulators
   

   This starts Auth (port 9099), Firestore (port 8080), and Storage (port 9199) under the local demo-codewithahsan project. The emulator UI is available at http://localhost:4000.

5. Seed the emulator with sample data

   In a new terminal:

   npm run seed
   

   This populates Firestore with sample users, mentorship profiles, projects, roadmaps, and an admin password (admin). Re-running the command clears and re-seeds all data.

6. Start the development server

   npm run dev
   

   The app is now running at http://localhost:3000.

---

Available Scripts

Script	Description
npm run dev	Start Next.js dev server with Turbopack
npm run emulators	Start Firebase emulators (Auth, Firestore, Storage)
npm run seed	Clear and re-seed emulator with sample data
npm run seed:clear	Clear all seed data without re-seeding
npm run build	Production build (also runs content prebuild and sitemap)
npm start	Start production server (after build)
npm run lint	Run ESLint
npm test	Run all Vitest unit tests
npm run test:watch	Run Vitest in watch mode
npm run test:rules	Run Firestore security rules tests against emulator

---

Project Structure

src/
  app/               # Next.js App Router — pages, layouts, API routes
  components/        # Reusable React components
  lib/               # Firebase client/admin init, utility libraries
  services/          # Data access layer (Firestore queries, external APIs)
  types/             # Shared TypeScript types and interfaces
scripts/             # Utility and maintenance scripts (tsx)
content/             # MDX course and blog content
firestore.rules      # Firestore security rules
storage.rules        # Storage security rules
firebase.json        # Firebase project config (emulator ports, etc.)

---

Contributing

See CONTRIBUTING.md for the full contributor guide.

Quick summary:

• Fork the repo and create a branch from main
• Follow the local setup steps above
• Run npm test and npm run test:rules before opening a PR
• Open a pull request with a clear description

---

About the Author

I'm a Muslim, an author of 3 world-wide published books, a Google Developers Expert in AI & Angular, an international speaker, and a Software Architect. I create tech tutorials on YouTube and write articles at my blog https://blog.codewithahsan.dev.

---

License

This project does not currently have an open-source license. Please contact the author before reusing code commercially.