Skip to content

Latest commit

 

History

History

README.md

EchoNext Documentation

Welcome to the EchoNext documentation! This comprehensive guide will help you build type-safe, well-documented APIs with automatic OpenAPI generation.

📚 Documentation Structure

Getting Started

Guides

CLI Tool

Contrib Packages

  • Database - GORM helpers, repository pattern, and Atlas migrations
  • Config - Configuration management with Viper
  • Testing - APIClient, fixtures, factories, and test suites
  • Middleware - RequestID, metrics, logging, and OpenTelemetry

API Reference

Architecture

Examples

Advanced Topics

Contributing

Additional Resources

🚀 Quick Links

💡 How to Use This Documentation

  1. New to EchoNext? Start with Quick Start
  2. Building an API? Check out API Development Guide
  3. Using the CLI? See CLI Overview
  4. Need examples? Browse Example Projects
  5. Having issues? Check Troubleshooting

📖 Documentation Version

This documentation is for EchoNext v1.4.0 and later.

🤝 Help Improve This Documentation

Found an error or want to improve something? Contributions are welcome!

📄 License

This documentation is licensed under the MIT License, same as EchoNext.