diff --git a/README.md b/README.md index b5c7fe5f139f5c39d336b0a7601a516b7361acf7..3408e33f9732450e0205090d0f0cccb4e38930f6 100644 --- a/README.md +++ b/README.md @@ -1,189 +1,93 @@ -
- README in English - 简体中文版自述文件 -
+# Gitos -![Magic Open Source Product Matrix](https://cdn.letsmagic.cn/static/img/super-magic-publish-header.png) +A Ruby on Rails application for task and project management with customizable workflows. -# 🔥 Magic - First Open-Source All-in-One AI Productivity Platform +## Features -
-

- - Static Badge - - - Stable Version - - - Commits last month - - - Issues closed - - - Discussion posts - - - Static Badge - -

-
+- **Task Management**: Track tasks with support for custom statuses and categories +- **Project Tracking**: Organize work into projects with iteration planning +- **User Management**: Role-based access control for teams +- **Inventory Management**: Warehouse tracking capabilities +- **Custom Workflows**: Flexible status/category configurations for projects and tasks -Magic aims to help enterprises of all sizes quickly build and deploy AI applications to achieve a 100x increase in productivity. +## Installation -## Magic Product Matrix +### Docker Setup (Recommended) -Magic is the first **"open-source all-in-one AI productivity platform"**, not a single AI product, but a comprehensive product matrix with rich capabilities. - -![Product Matrix](https://cdn.letsmagic.cn/static/img/super-magic-open-source-projects.png) - -- **[Super Magic](https://github.com/dtyq/super-magic)** - A **general-purpose AI Agent** designed for complex task scenarios -- **[Magic IM](https://github.com/dtyq/magic)** - An enterprise-grade instant messaging system that integrates AI Agent conversations with internal enterprise communication -- **[Magic Flow](https://github.com/dtyq/magic-flow)** - A powerful visual AI workflow orchestration system -- **Teamshare OS** (Coming soon) - An enterprise-grade online collaborative office system - -In addition to the above AI products, we have also open-sourced some of the infrastructure we used to build these products: - -- **[Agentlang](https://github.com/dtyq/agentlang)** - A language-first AI Agent Framework for building AI agents with natural language (currently available in Python version, TypeScript version coming soon) -- **[Magic Lens](https://github.com/dtyq/magiclens)** - A powerful and flexible HTML to Markdown conversion tool that uses an extensible rule system to accurately convert complex HTML documents to concise Markdown format -- **Magic Use** (Coming soon) - A revolutionary browser operation tool specifically designed for AI Agents -- **Magic Space** (Coming soon) - A new static content hosting management system specifically designed for AI Agents -- **Sandbox OS** (Coming soon) - A powerful sandbox system for AI Agent runtime - -### Super Magic - -A powerful **general-purpose AI Agent** specially designed for complex task scenarios. Through a multi-agent design system and rich tool capabilities, Super Magic supports intelligent abilities such as **autonomous task understanding**, **autonomous task planning**, **autonomous action**, and **autonomous error correction**. It can understand natural language instructions, execute various business processes, and deliver final target results. As the flagship product of the Magic product matrix, Super Magic provides powerful secondary development capabilities through open source, allowing enterprises to quickly build and deploy intelligent assistants that meet specific business needs, greatly improving decision-making efficiency and quality. - -![Super Magic](https://cdn.letsmagic.cn/static/img/super-magic-buffett.gif) - -#### Super Magic Case Studies -- [Warren Buffett's 2025 Shareholder Meeting Investment Insights Analysis](https://www.letsmagic.ai/share/777665156986277889) -- [Beijing Humanoid Robot Half Marathon Related Stock Analysis](https://www.letsmagic.ai/share/774280936479625217) -- [Core Concepts Summary of "Thinking, Fast and Slow"](https://www.letsmagic.ai/share/777461325648195584) -- [Shanghai Auntie IPO Analysis and Investment Recommendations](https://www.letsmagic.ai/share/777604044873928705) -- [SKU Sales Forecast Requirements](https://www.letsmagic.ai/share/771022574397648897) -- For more case studies, please visit the [Official Website](https://www.letsmagic.ai) - -### Magic Flow - -Magic Flow is a powerful visual AI workflow orchestration system that allows users to build complex AI Agent workflows on a free canvas. It has the following core features: - -- **Visual Orchestration**: Intuitive drag-and-drop interface allows designing complex AI workflows without coding, easily implementing various functional combinations through node connections. -- **Rich Component Library**: Built-in variety of preset components, including text processing, image generation, code execution modules, meeting diverse business needs. -- **Comprehensive Model Support**: Compatible with any large model following the OpenAI API protocol, flexibly choosing AI capabilities suitable for business scenarios. -- **System Integration Capability**: Seamless integration with Magic IM and other third-party IM systems (WeCom, DingTalk, Feishu), enabling cross-platform collaboration. -- **Custom Extensions**: Support for custom tool node development to meet specific business scenario requirements. -- **Real-time Debugging and Monitoring**: Providing comprehensive debugging and monitoring functions to help quickly identify and solve problems in workflows, ensuring stable operation of AI applications. - -![Magic Flow](https://cdn.letsmagic.cn/static/img/magic-flow.png) - -As an important component of the Magic product matrix, Magic Flow can be seamlessly integrated with other Magic products to create a complete enterprise-level AI application ecosystem. - -![Magic Multi-Agents and Events](https://cdn.letsmagic.cn/static/img/super-magic-multi-agents-and-events.png) - -### Magic IM - -Magic IM is an enterprise-grade AI Agent conversation system designed specifically for internal knowledge management and intelligent customer service scenarios. It provides rich conversational capabilities, supporting multi-turn dialogues, context understanding, knowledge base retrieval, and other functions, allowing enterprises to quickly build intelligent customer service, knowledge assistants, and other applications. - -Magic IM has the following core features: - -- **Knowledge Base Management**: Powerful knowledge base management functions, supporting import of various document formats, automatic indexing, and semantic retrieval, ensuring AI answers based on authentic enterprise knowledge. -- **Conversation Management**: Comprehensive conversation management, supporting topic distinction for different conversation content, enabling both AI Agent conversations and communication with people within the organization. -- **Group Chat Capability**: Powerful group chat functionality, supporting real-time collaborative discussions among multiple people, with AI intelligently participating in group chats and providing instant answers, promoting efficient team communication and knowledge sharing. -- **Multi-organizational Architecture**: Support for multi-organization deployment and strict organizational data isolation, with each organization having independent data space and access permissions. -- **Data Security**: Strict data isolation and access control mechanisms, multi-level permission management, safeguarding sensitive enterprise information and ensuring no data leakage between organizations. - -![Magic IM](https://cdn.letsmagic.cn/static/img/magic-im-group-chat.png) - -## Teamshare OS - -Teamshare OS is a modern enterprise-grade collaborative office platform designed to enhance team collaboration efficiency and knowledge management. As an important component of the Magic product matrix, Teamshare deeply integrates AI capabilities into daily office scenarios, achieving intelligent workflows and knowledge management. - -Teamshare OS has the following core features: - -- **Intelligent Document Management**: Support for online editing, collaboration, and version control of various document formats, AI-assisted content generation and optimization, making team document management more efficient. -- **Magic Table**: Powerful multi-dimensional data management tool, supporting custom field types, diverse views, and automated workflows, combined with AI capabilities to achieve intelligent data processing, meeting diverse data management needs. -- **Project Collaboration Management**: Intuitive project boards and task management, supporting custom workflows, combined with AI intelligent analysis to provide project progress forecasting and resource optimization suggestions. -- **Knowledge Base**: Powerful knowledge consolidation and retrieval system, automatically structuring internal enterprise documents to form sustainable accumulated enterprise knowledge assets. -- **Comprehensive Integration Capability**: Seamless integration with Magic product matrix, while supporting connection with mainstream office software and enterprise applications, creating a unified work platform. - -### Magic Table +```bash +# Clone repository +git clone https://github.com/yourusername/gitos.git +cd gitos -https://gist.github.com/user-attachments/assets/6ef46e66-292c-4a8a-8a00-a3b9fb7beec7 +# Start containers +docker-compose up -d +``` -### Magic Doc +Access the application at [http://localhost:3000](http://localhost:3000) -https://gist.github.com/user-attachments/assets/7327f331-be7d-4aeb-8e19-0949adde66b2 +### Manual Setup -## 🚀 Using Super Magic +```bash +# Install dependencies +bundle install +yarn install -### Cloud Service +# Setup database +rails db:create +rails db:migrate +rails db:seed -We provide [cloud services](https://www.letsmagic.ai) for [Super Magic](https://www.letsmagic.ai), [Magic IM](https://www.letsmagic.ai), and [Magic Flow](https://www.letsmagic.ai), allowing anyone to start trying and using them with zero setup, providing all features of the open-source version. -*Currently, an invitation code is required for access, which can be applied for online and granted for trial use after approval.* +# Start development server +rails server +``` -### Magic for Enterprises/Organizations +## Usage -We provide more powerful management capabilities and features for teams and enterprises. [Send us an email](mailto:bd@dtyq.com?subject=[GitHub]Business%20License%20Inquiry) to discuss enterprise needs. +1. Access the application at [http://localhost:3000](http://localhost:3000) +2. Default credentials (if configured) can be found in `db/seeds.rb` +3. Use the admin interface to configure custom statuses/categories -### Self-hosted Community Edition - -#### System Requirements -- Docker 24.0+ -- Docker Compose 2.0+ +## Development -#### Start the System Using Docker +### Code Quality Checks ```bash -# Clone repository -git clone https://github.com/dtyq/magic.git -cd magic +# Run Brakeman security scanner +brakeman -# Start service in foreground -./bin/magic.sh start +# Run Rubocop style checker +rubocop ``` -##### Other Commands +### Testing ```bash -# Start service in background -./bin/magic.sh daemon - -# Check service status -./bin/magic.sh status - -# View logs -./bin/magic.sh logs +# Run tests +rails test ``` -##### Access Services -- API Service: http://localhost:9501 -- Web Application: http://localhost:8080 - - Account `13812345678`：Password `letsmagic.ai` - - Account `13912345678`：Password `letsmagic.ai` -- RabbitMQ Management Interface: http://localhost:15672 - - Username: admin - - Password: magic123456 - - -Official Website: [https://www.letsmagic.ai](https://www.letsmagic.ai) -Documentation: [https://docs.letsmagic.cn/en](https://docs.letsmagic.cn/en) - -## Contribution -For those who want to contribute code, please refer to our [Contribution Guide](https://github.com/dtyq/magic/blob/main/CONTRIBUTING.md). -Also, please consider supporting Magic through social media, events, and conferences. The development of Magic relies on your support. +## Contributing -## Security Vulnerabilities +1. Fork the repository +2. Create a new feature branch +3. Implement changes with proper test coverage +4. Fix any Rubocop/Brakeman issues +5. Submit a pull request with detailed description -If you discover a security vulnerability in Magic, please send an email to the Magic official team at dev@dtyq.com. All security vulnerabilities will be promptly addressed. +## System Requirements -## 📄 License +- Ruby 2.7+ +- PostgreSQL 12+ +- Node.js 14+ +- Yarn package manager -This repository follows the [Magic Open Source License](LICENSE), which is essentially Apache 2.0 but with some additional restrictions. +## License -## 🙏 Acknowledgements +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details -Thanks to all developers who have contributed to Magic! +## Acknowledgments -[![Star History Chart](https://api.star-history.com/svg?repos=dtyq/magic&type=Date)](https://star-history.com/#dtyq/magic&Date) \ No newline at end of file +- Built with Ruby on Rails framework +- Uses PostgreSQL for relational data storage +- Includes Devise for authentication +- Frontend assets managed with Webpacker \ No newline at end of file