README.md

ByteProxy

A powerful, extensible web proxy built with Elysia for seamless API forwarding to Discord, GitHub, and more. Features built-in rate limiting, dynamic service management, robust error handling, and interactive API docs.

---

🚀 Features

• Multi-Service Proxy: Discord, GitHub, and custom APIs
• Rate Limiting: Per-service, configurable
• Dynamic Service Management: Add/remove services at runtime
• CORS Support: Configurable origins
• Comprehensive Logging: Request/response logs
• Health Monitoring: /health and /status endpoints
• Swagger Docs: Interactive API docs at /docs
• TypeScript: Fully typed for reliability

---

📚 Documentation

• API Reference & Usage:
  Interactive Swagger documentation at /docs
• Configuration:
  See src/config/index.ts for service configuration options and our Configuration Guide
• Troubleshooting:
  Use /manage/diagnostics for system diagnostics or see our Troubleshooting Guide
• Full Documentation:
  Visit our Documentation Website for comprehensive guides:
  • Getting Started
  • Usage Examples
  • Self-Hosting Guide
  • API Reference
  • Security & Authentication

---

🛠️ Development

• Project Structure:

  • src/config/ - Service and system configuration
  • src/routes/ - API endpoint definitions
  • src/middleware/ - Authentication and CORS handlers
  • src/utils/ - Logging and helper utilities
  • src/services/ - Core service implementations

• Scripts:

  • bun run dev — Development mode with hot reloading
  • bun run build — Build TypeScript project
  • bun run start — Start production server
  • bun run test — Run test suite

---

💡 Support & Community

• Create an issue
• Join our Discord
• Documentation

---

📄 License

AGPL-3.0 © NodeByte LTD - View License

---

Built with ❤️ by NodeByte.