platform/README.md

74 lines
6.1 KiB
Markdown
Raw Normal View History

2024-06-22 04:56:57 +00:00
# Protevus Platform
2024-06-22 04:56:57 +00:00
> **Note:** This repository contains the core code of the Protevus Platform. If you want to build an application using Protevus, visit the main [Protevus repository](https://github.com/protevus/protevus).
2024-06-22 04:56:57 +00:00
Protevus Platform is a highly versatile and extensible application server platform for the Dart programming language. Inspired by the Laravel framework, Protevus aims to provide a familiar and Laravel-compatible API, allowing developers to leverage their existing Laravel knowledge and experience in the Dart ecosystem.
## AI Assistance
The Protevus Platform project utilizes AI assistance in various aspects of its development process. We believe in leveraging the capabilities of AI to enhance productivity, code quality, and overall project progress while maintaining transparency and adhering to ethical practices.
### AI Tools and Models
The following AI tools and models have been employed in the development of the Protevus Platform:
- **Claude** (Anthropic): A conversational AI assistant trained by Anthropic. Claude has been utilized for research, ideation, and problem-solving during the development process. Claude assists with documentation, code generation, code refactoring, and code testing.
- **Keymate** (Keymate.ai): A conversational chatGPT AI assistant trained by Protevus using long-term memory provided by keymate.ai. Keymate is used to provide context and project scope during development. Keymate assists with porting, refactoring and testing of code.
- **Code Copilot** (promptspellsmith.com): A conversational chatGPT AI assistant trained by PromptSpellSmith. Code Copilot is used to provide validation during development. Code Copilot assists with code validation, code generation and refactoring.
2024-06-25 19:42:51 +00:00
- **Cody** (sourcegraph): A conversational AI coding assistant trained by Sourcegraph that utilizes Claude. Cody lives inside our IDE and is used to provide code completion, code navigation and code documentation during development. Cody assists with advanced search and codebase context that help developers understand, write, and fix code faster.
### Guidelines and Limitations
While AI assistance has been invaluable in accelerating certain aspects of development, it is important to note the following guidelines and limitations:
- All code generated or modified with the help of AI tools undergoes thorough manual review, testing, and validation by the project's core team to ensure quality, security, and adherence to project standards.
- AI-generated code is treated as a starting point or reference, and human developers are responsible for understanding, modifying, and maintaining the codebase.
- Sensitive or confidential information is never shared with AI models, and appropriate measures are taken to protect intellectual property and data privacy.
- The project's core team retains full ownership and responsibility for the codebase and its development.
We believe in the responsible and ethical use of AI assistance and are committed to fostering an open and transparent development process. If you have any questions or concerns regarding the use of AI in the Protevus Platform project, please feel free to reach out to the project maintainers.
2024-06-22 04:56:57 +00:00
## Features
2024-06-22 04:56:57 +00:00
- **Laravel API Compatibility**: Protevus Platform offers a high degree of compatibility with the Laravel API, enabling developers to seamlessly transition from Laravel to the Dart ecosystem.
- **Modular Architecture**: The platform follows a modular design, separating core components and libraries from specific application implementations, promoting reusability and maintainability.
- **High Performance**: Built on top of the multi-threaded Conduit API, Protevus Platform delivers exceptional performance and scalability for demanding applications.
- **Extensibility**: With its modular architecture and support for custom extensions, Protevus Platform can be tailored to meet diverse project requirements.
- **Community-Driven**: Protevus Platform embraces open-source principles and encourages community contributions, fostering collaboration and knowledge sharing.
- **Modular Packages**: Each Illuminate component is available as a standalone Dart package.
- **Comprehensive Routing**: Powerful routing capabilities inspired by Laravel.
- **Dependency Injection**: Built-in support for dependency injection to promote loose coupling.
- **Middleware Support**: Use middleware for filtering HTTP requests entering your application.
- **Authentication & Authorization**: Robust tools for user authentication and authorization.
- **Database Abstraction**: Database-agnostic query builder and ORM.
- **Queueing System**: Manage background tasks and queues.
- **Event Broadcasting**: Real-time event broadcasting for modern applications.
- **Full-Stack Experience**: Protevus Platform offers a complete full-stack development experience, including backend development with server-side views and the ability to build cross-platform frontends using Flutter.
## Getting Started
2024-06-22 04:56:57 +00:00
To get started with Protevus Platform, follow these steps:
2024-06-22 04:56:57 +00:00
1. **Install Dependencies**: Ensure you have the Dart SDK and the necessary dependencies installed on your system.
2. **Clone the Repository**: Clone the Protevus Platform repository to your local machine.
3. **Build and Run**: Follow the instructions in the repository's documentation to build and run the platform.
2024-06-22 04:56:57 +00:00
## Documentation
2024-06-22 04:56:57 +00:00
Comprehensive documentation for Protevus Platform is available at [protevus.com/docs/platform](https://protevus.com/docs/platform). The documentation covers installation, configuration, usage, and advanced topics, including guides and examples.
## Contributing
2024-06-22 04:56:57 +00:00
We welcome contributions from the community! If you'd like to contribute to Protevus Platform, please follow the guidelines outlined in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
## License
2024-06-22 04:56:57 +00:00
Protevus Platform is released under the [MIT License](LICENSE).
## Support and Community
2024-06-22 04:56:57 +00:00
If you have any questions, issues, or suggestions, please join our community:
2024-06-22 04:56:57 +00:00
- **GitHub Discussions**: [github.com/protevus/platform/discussions](https://github.com/protevus/platform/discussions)
- **Twitter**: [@Protevus](https://twitter.com/Protevus)