Skip to content
MossaJehadPublic

About

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

42 Network API Documentation Dashboard

A modern, fast, and responsive single-file developer portal and documentation dashboard for the 42 Network Intra API (v2.0), built with the design language of shadcn-html and Tailwind CSS.

🌐 Live Demo

Visit the deployed documentation dashboard on GitHub Pages: https://mossajehad.github.io/42API/


✨ Highlights & Features

  • shadcn/ui Design Language: Built using semantic HTML, pure vanilla JavaScript, and modern Tailwind CSS with zinc design tokens.
  • No Build Step: 100% self-contained single-page dashboard. Open directly via index.html in any browser or deploy on any static host.
  • 741 Endpoints Across 97 Resources: Completely structured and parsed with 100% data fidelity from official 42 Network API documentation.
  • Color-Coded HTTP Method Badges:
    • GET: Emerald Green
    • POST: Blue
    • PATCH: Amber
    • PUT: Yellow
    • DELETE: Red / Destructive
  • Path Parameter Highlighting: Dynamic URL variables (e.g., :id, :campus_id) highlighted with distinct styling.
  • Restricted & User Auth Badges: Modern badges with Lucide icons (key-round, user-check, globe) replacing legacy icons.
  • Real-time Search & Filtering: Sub-millisecond instant search across endpoints, paths, methods, resources, and auth tags.
  • Interactive cURL Snippets: Expandable details drawers with copy-to-clipboard cURL commands and path parameter guides.
  • Command Palette (⌘K / Ctrl+K): Keyboard-driven modal search dialog to jump directly to any endpoint.
  • Full Specification & Guides: Embedded guides covering OAuth 2.0 flow, token inspection (/oauth/token/info), scopes, pagination headers, filtering, sorting, and HTTP error code status tables.
  • Dark Mode: Built-in dark/light theme toggle supporting system preference and persisting to localStorage.

🚀 Local Development & Preview

Clone the repository and open the HTML file:

git clone git@github.com:MossaJehad/42API.git
cd 42API
open index.html

Or run a local static HTTP server:

python3 -m http.server 3000
# Visit http://localhost:3000

To re-generate or rebuild index.html from raw source documentation files:

python3 generate.py

🛠️ Tech Stack

  • HTML5 & Semantic Elements
  • Tailwind CSS (via CDN)
  • Lucide Icons (via CDN)
  • Google Fonts (Inter & JetBrains Mono)
  • Vanilla JavaScript (ES6+)
  • GitHub Actions & GitHub Pages

About

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages