0.2.3 β€’ Published 8 months ago

prisma-hono-generator v0.2.3

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

Prisma Hono Generator πŸš€

⚠️ Work In Progress: This project is under active development and not ready for production use. We welcome contributors!

Generate type-safe Hono API routes from your Prisma schema automatically. This generator creates CRUD endpoints with proper validation, error handling, and documentation out of the box.

Vision ✨

  • πŸ”„ Complete CRUD route generation from Prisma schema
  • πŸ›‘οΈ Type-safe request/response handling with Zod
  • πŸ“ OpenAPI/Swagger documentation
  • ⚑ Edge-ready (works with Vercel Edge, Cloudflare Workers)
  • πŸ” Query parameter support
  • 🚨 Built-in error handling

Project Status πŸ—οΈ

This project is in early development. Check our Project Board to see what we're working on.

Current Focus

  • Basic CRUD route generation
  • Core validation system
  • Error handling framework
  • Initial documentation

Contributing 🀝

We're actively looking for contributors! Whether you're interested in coding, documentation, or testing, there's room for you to make an impact.

Prerequisites

  • Node.js >= 16
  • npm >= 7
  • Basic knowledge of TypeScript, Prisma, and Hono

Getting Started

  1. Fork & Clone

    git clone https://github.com/your-username/prisma-hono-generator
    cd prisma-hono-generator
  2. Install Dependencies

    npm install
  3. Start Development

    npm run dev

Project Structure

prisma-hono-generator/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ generator/    # Core generator logic
β”‚   β”œβ”€β”€ templates/    # Route templates
β”‚   └── utils/        # Helper functions
β”œβ”€β”€ examples/         # Example projects
β”œβ”€β”€ tests/           # Test suite
└── docs/            # Documentation

Development Workflow

  1. πŸ“‹ Check Issues for tasks or create a new one
  2. πŸ” Read our Contributing Guide for code standards
  3. βœ… Write tests for your changes
  4. πŸ’» Make your changes
  5. πŸ§ͺ Ensure tests pass (npm test)
  6. πŸ“š Update documentation if needed
  7. πŸš€ Submit a PR

Available Commands

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run test - Run tests
  • npm run lint - Run linter
  • npm run format - Format code

Communication πŸ’¬

  • πŸ’‘ Discussions - For ideas and general questions
  • πŸ› Issues - For bugs and feature requests
  • πŸ’¬ Discord - For real-time discussion

Roadmap πŸ—ΊοΈ

See our detailed Roadmap for planned features and milestones.

Next Major Milestones

  1. Alpha Release

    • Basic CRUD operations
    • Simple validation
    • Basic error handling
  2. Beta Release

    • OpenAPI documentation
    • Advanced filtering
    • Relationship handling
  3. 1.0 Release

    • Production-ready features
    • Complete documentation
    • Comprehensive test coverage

License πŸ“„

MIT Β© Your Organization


Want to Contribute?

We're looking for help with:

  • πŸ§ͺ Testing infrastructure
  • πŸ“š Documentation improvements
  • πŸ’» Core functionality development
  • 🎨 Example projects
  • 🌐 Website development

Join our community and help build something awesome!

codecov

Commit Message Convention

This project follows Conventional Commits:

  • feat: add new feature - New features (minor version)
  • fix: resolve bug - Bug fixes (patch version)
  • docs: update readme - Documentation only changes
  • style: format code - Changes that don't affect code meaning
  • refactor: improve code - Code changes that neither fix bugs nor add features
  • perf: improve performance - Performance improvements
  • test: add tests - Adding or updating tests
  • chore: update deps - Changes to build process or auxiliary tools
  • BREAKING CHANGE: description - Breaking API changes (major version)

Example with breaking change:

0.2.3

8 months ago

0.2.2

8 months ago

0.2.1

8 months ago

0.2.0

8 months ago

1.0.0

8 months ago

0.0.1

8 months ago