Eagle Core

A powerful and flexible Bun framework designed for building robust API with modern best practices and high performance.

Features

• 🚀 High Performance - Optimized for speed and efficiency
• 🛡️ Secure by Design - Built-in security features and best practices
• 🎯 Modern Architecture - Following SOLID principles and clean code practices
• 🔌 Modular System - Easily extendable with plugins and modules
• 📦 Dependency Injection - Built-in DI container for better code organization
• 🔍 Type Safety - Strict typing for more reliable code
• 📝 Well Documented - Comprehensive documentation and examples
• ✅ Fully Tested - Extensive test coverage
• ⚡ CLI Tools - Powerful command-line interface for development

Documentation

🔜 Coming soon!

Quick Start

🔜 Coming soon!

Contributing

We welcome contributions to Ooneex Eagle Core! Here's how you can help:

Development Setup

1. Fork and clone the repository
2. Install Bun if you haven't already
3. Run bun test to ensure everything is working
4. Create a new branch for your feature/fix: git checkout -b feature/your-feature-name
5. Make your changes and commit them using conventional commits
6. Run tests and ensure they pass: bun test
7. Push to your fork and submit a pull request
8. Follow the pull request template and provide detailed description
9. Wait for review and address any feedback

Code Style Guidelines

• Follow deno formatting guidelines
• Use meaningful variable and function names
• Add JSDoc comments for public APIs
• Keep functions small and focused
• Use proper error handling

Testing Guidelines

• Write unit tests for all new features
• Use descriptive test names
• Mock external dependencies
• Test edge cases and error scenarios

Useful Commands

• bun run test - Run tests
• bun run test:watch - Run tests with watch mode
• bun run test:coverage - Run tests with coverage
• bun run test:coverage:watch - Run tests with coverage and watch mode
• bun run fmt - Format code
• bun run lint - Lint code

Issue Guidelines

When creating issues:

1. Use the issue templates
2. Provide clear reproduction steps
3. Include relevant system information
4. Add labels appropriately
5. Link related issues/PRs
6. Include screenshots if relevant

Support

• GitHub Issues for bug reports
• Discussions for questions
• Stack Overflow for technical help
• Email support for security issues

License

This project is licensed under the MIT License - see the LICENSE file for details.