Changelog

Changelog

All notable changes to the OpenSauce platform.

[Unreleased]

Added

• Initial public release of OpenSauce
• Recipe API with full CRUD operations
• User authentication via GitHub OAuth
• Dashboard for managing API keys and recipes
• Documentation site with Starlight
• Website for browsing recipes

Changed

• N/A

Fixed

• N/A

[1.0.0] - 2024-01-15

Added

• API: Complete recipe management API

  • GET /api/v1/recipes - List all approved recipes
  • GET /api/v1/recipes/:id - Get specific recipe
  • POST /api/v1/recipes - Submit new recipe
  • PATCH /api/v1/admin/recipes/:id - Update recipe status

• Auth: GitHub OAuth integration

  • GET /api/v1/auth/github - Initiate OAuth flow
  • GET /api/v1/auth/github/callback - Handle OAuth callback
  • GET /api/v1/auth/me - Get current user
  • POST /api/v1/auth/logout - Sign out

• Dashboard: Full-featured dashboard

  • API key management
  • Recipe submission and management
  • Account settings
  • Activity tracking

• Website: Public-facing website

  • Recipe browsing
  • Search and filtering
  • Feature showcases
  • Developer-focused design

• Docs: Comprehensive documentation

  • API reference
  • Getting started guides
  • Authentication documentation

Technical Details

• Runtime: Bun 1.0+
• Backend: Hono web framework
• Database: Cloudflare D1
• Storage: Cloudflare KV (for caching)
• Authentication: JWT with GitHub OAuth
• Validation: Zod schemas
• Frontend: Astro with Tailwind CSS

Versioning

We use Semantic Versioning for our API and platform.

• MAJOR: Breaking changes to the API
• MINOR: New features (backwards-compatible)
• PATCH: Bug fixes (backwards-compatible)

Deprecation Policy

• Deprecated endpoints will be announced in the changelog
• Deprecated endpoints will continue to work for at least 3 months
• Migration guides will be provided for major changes

Contributing

We welcome contributions! Please see our GitHub repository for contribution guidelines.

License

The OpenSauce platform is open source. See the LICENSE file for details.