mmainguy/photos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
10 Commits 1 Branch 0 Tags 185 KiB
TypeScript 95.6%
CSS 4%
JavaScript 0.4%
a204168c00
Go to file
Michael Mainguy a204168c00 Add automatic API documentation system with OpenAPI 3.0 spec 
## Features Added:
- **Automatic Documentation Generation**: Uses next-swagger-doc to scan API routes
- **Interactive Swagger UI**: Try-it-out functionality for testing endpoints
- **OpenAPI 3.0 Specification**: Industry-standard API documentation format
- **Comprehensive Schemas**: Type definitions for all request/response objects

## New Documentation System:
- `/docs` - Interactive Swagger UI documentation page
- `/api/docs` - OpenAPI specification JSON endpoint
- `src/lib/swagger.ts` - Documentation configuration and schemas
- Complete JSDoc examples for batch classification endpoint

## Documentation Features:
- Real-time API testing from documentation interface
- Detailed request/response examples and schemas
- Parameter validation and error response documentation
- Organized by tags (Classification, Captioning, Tags, etc.)
- Dark/light mode support with loading states

## AI Roadmap & Guides:
- `AIROADMAP.md` - Comprehensive roadmap for future AI enhancements
- `API_DOCUMENTATION.md` - Complete guide for maintaining documentation

## Benefits:
- Documentation stays automatically synchronized with code changes
- No separate docs to maintain - generated from JSDoc comments
- Professional API documentation for integration and development
- Export capabilities for Postman, Insomnia, and other tools

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-27 17:21:53 -05:00
.idea Initial Next.js photo gallery application 2025-08-26 13:24:38 -05:00
src Add automatic API documentation system with OpenAPI 3.0 spec 2025-08-27 17:21:53 -05:00
.gitignore Add SQLite database and directory management system 2025-08-26 14:26:55 -05:00
AIROADMAP.md Add automatic API documentation system with OpenAPI 3.0 spec 2025-08-27 17:21:53 -05:00
API_DOCUMENTATION.md Add automatic API documentation system with OpenAPI 3.0 spec 2025-08-27 17:21:53 -05:00
CLAUDE.md Add automatic API documentation system with OpenAPI 3.0 spec 2025-08-27 17:21:53 -05:00
next.config.js Add photo scanning with EXIF metadata extraction and thumbnail caching 2025-08-27 08:35:07 -05:00
package-lock.json Add automatic API documentation system with OpenAPI 3.0 spec 2025-08-27 17:21:53 -05:00
package.json Add automatic API documentation system with OpenAPI 3.0 spec 2025-08-27 17:21:53 -05:00
postcss.config.mjs Initial Next.js photo gallery application 2025-08-26 13:24:38 -05:00
README.md Improve directory modal with keyboard navigation and README 2025-08-26 14:03:36 -05:00
tsconfig.json Initial Next.js photo gallery application 2025-08-26 13:24:38 -05:00

README.md

Photos Gallery

A Next.js application for displaying and organizing photos.

Prerequisites

macOS CIFS Share Access

If you're running this application on macOS and accessing photos from a mounted CIFS share, you'll need to grant your terminal application full disk access:

  1. Open System Preferences → Security & Privacy → Privacy
  2. Select Full Disk Access from the left sidebar
  3. Click the lock icon and enter your password to make changes
  4. Click the + button and add your terminal application (e.g., Terminal.app, iTerm2, etc.)
  5. Restart your terminal application

This is required because macOS restricts access to network-mounted drives without explicit permission.

Getting Started

npm install
npm run dev

Open http://localhost:3000 in your browser.