Welcome to the central documentation for the ICAP project. This document provides an overview of ICAP and points to the various repositories that form parts of the entire system.
ICAP (Integrated Chat AI Platform) is a cutting-edge software development project aimed at developing an AI Chat platform. This platform serves as a bridge, interfacing with multiple LLM projects and seamlessly integrates AI community plugins. Built with security, scalability, and extensibility in mind, ICAP is designed for hosting in corporate environments.
- Interface with Multiple LLM Projects: Ensuring compatibility and interoperability with a wide range of projects.
- AI Community Plugin Integration: Easily extend functionality by leveraging the power of the community.
- MVC Approach: Utilizing the Model-View-Controller approach to ensure a scalable and maintainable codebase.
- Micro-services Architecture: Modular and decoupled services to ensure scalability and resilience.
- Event-Driven Architecture: React to events in real-time for a dynamic and responsive system.
- RESTful API: Ensuring easy integration with other systems and tools.
- Focused on Security: Built from the ground up with a high emphasis on security to ensure data protection and compliance in corporate settings.
Our project is split across multiple repositories for modularity and ease of maintenance. Below are the main repositories:
- (.github): A special Github repository for organization to centralize project management accross the organization.
- (Documentation): Repository for the project and product documentations.
- (FrontEnd-Client): Client side FrontEnd supporting the main UI to interact with LLM engine via Chat.
- (FrontEnd-Admin): Admin FrontEnd to manage the platform, user management and integration with Enterprise Systems.
- (BackEnd): The backend manage calls between internal and external components, like the FrontEnds, the different LLM API, and community plugins, via a RestFul-API interface.
Details or guidelines about how to configure the platform and specific configuration details can be found in the individual repository READMEs and Docs.
Organization Level Documentation
For global project level documentation, discussions and issues refer to the repository .github:
Detailed ICAP Documentation
Please refer to our Wiki or explore the individual repository documentation located in the Docs folder.
Repository 1:
Repository 2:
End to End Deployments and CI/CD will be included in the near future in this section.
We value community contributions! If you're keen to contribute, please read our central
This project is licensed under MIT License - see the (LICENSE.md) file for details.
For support, feedback, or any queries, please contact us our (Wiki) or raise an issue in the repository.
Join us in building the future of AI chat platforms with ICAP!