prisma-hono-generator v0.2.3
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
Fork & Clone
git clone https://github.com/your-username/prisma-hono-generator cd prisma-hono-generator
Install Dependencies
npm install
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
- π Check Issues for tasks or create a new one
- π Read our Contributing Guide for code standards
- β Write tests for your changes
- π» Make your changes
- π§ͺ Ensure tests pass (
npm test
) - π Update documentation if needed
- π Submit a PR
Available Commands
npm run dev
- Start development servernpm run build
- Build for productionnpm run test
- Run testsnpm run lint
- Run linternpm 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
Alpha Release
- Basic CRUD operations
- Simple validation
- Basic error handling
Beta Release
- OpenAPI documentation
- Advanced filtering
- Relationship handling
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!
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 changesstyle: format code
- Changes that don't affect code meaningrefactor: improve code
- Code changes that neither fix bugs nor add featuresperf: improve performance
- Performance improvementstest: add tests
- Adding or updating testschore: update deps
- Changes to build process or auxiliary toolsBREAKING CHANGE: description
- Breaking API changes (major version)
Example with breaking change: