diff --git a/README.md b/README.md index f6b33e00..083b50ad 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,73 @@ > [!CAUTION] > Still working on it, it will release soon -![LOGO](./assets/badge.svg) +![LOGO](./assets/codefox-badger.svg) -Welcome to CODEFOX! A next generation AI sequence full stack project generator with interactive chatbot +Welcome to CODEFOX! A next generation AI sequence full stack project generator with interactive chatbot. -# News +
-🌟 Oct. 18, 2024: First line of Codefox code committed. +[![Follow LinkedIn](https://img.shields.io/badge/Follow_Codefox-blue?style=flat&logo=linkedin)](https://www.linkedin.com) [![Follow X](https://img.shields.io/badge/Follow_Codefox-black?style=flat&logo=X)](https://x.com/Codefox_Tech) [![Join Discord](https://img.shields.io/badge/Join_Discord-5865F2?style=flat&logo=discord&logoColor=white)](https://discord.com) -# Exciting features +
-💻 **Transforming Ideas into Projects** -🚀 **Extraordinary Modeling System**: Integrates an AI model to seamlessly connect every aspect of your project. -🤖 **Multi-Agent Generator**: Create and manage multiple intelligent agents to enhance project functionality. -⚡ **One-Click Deployment**: Deploy your project effortlessly to cloud services or clone it locally with ease. -✨ **Live Preview**: Interact with your project while engaging in AI-powered conversations to make real-time modifications. -🔧 **Precise Code Customization**: Leverage targeted and efficient visual tools for precise module adjustments. +# 🎉News -## Support +Oct. 18, 2024: First line of Codefox code committed. -> [!WARNING] -> adding later +# 🌟Exciting Features + +### Build Your Project + +- **One-Sentence Fullstack Project Generation:** Generate a fully functional, end-to-end fullstack project based on just one sentence input. +- **Dynamic Project Creation:** Even with identical inputs, every project is uniquely crafted using adaptive algorithms, ensuring a personalized solution every time. +- **Diverse Project Types & Architectures:** Build projects across multiple architectures, including _modular or monolithic front-end and back-end systems_. + Upcoming features include _mobile app_ and _WeChat Mini Programs_. + +### Refine Your Project + +- **Interactive AI-Driven Project Refinement:** Fine-tune your project in real-time with AI-powered chat. Seamlessly optimize code and workflows as you go. +- **Token Capacity Assurance:** Generate fully deployable, production-grade projects ready for real-world applications—_no placeholders or toy projects_. +- **Multi-Agent Generator:** Design and manage multiple intelligent agents to enhance your project's functionality. +- **Live Preview:** Engage in AI-powered, real-time interactions to visualize and implement project changes. +- **Precise Code Customization:** Use powerful visual tools for targeted, efficient code adjustments that align with your specific requirements. + +### Deploy Your Project + +- **One-Click Deployment:** Deploy your project effortlessly to cloud platforms or clone it locally in a single step. +- **Extraordinary Modeling System:** Integrate AI models to harmoniously connect every aspect of your project for optimal performance. + +# 🤖How It Works -**Revolutionize development with this disruptive platform. Join now and set the new standard!** +This project supports **structured task orchestration** where tasks (nodes) are executed in a sequence or in parallel, depending on the configuration. The execution process is handled by several key components: + +- **BuilderContext**: Manages the global state, execution context, and node data. +- **BuildSequenceExecutor**: Drives the overall execution flow, managing steps and nodes. +- **BuildHandler**: Executes individual tasks (nodes) and stores results. +- **HandlerManager**: Provides specific handlers for nodes. +- **ModelProvider**: Integrates external services like LLM API calls. + +### **Sequence Diagram (Simplified Version)** ```mermaid -graph TD - subgraph Project_Generate_Layer[Project Generate Layer] - UP[User Project Info] --> PRD[Product Requirements Document] - PRD --> FRD[Feature Requirements Document] - PRD --> UXSD[UX Sitemap Document] - UXSD --> UXDD[UX Datamap Document] - UXDD --> DRD[Database Requirements Document] - DRD --> DBS[DB/schemas] - DRD --> DBP[DB/postgres] - DRD --> BRD[Backend Requirements Document] - - %% Frontend related generations - UXSD --> USS[ux/sitemap-structure] - USS --> ROUTE[frontend/routing] - UXDD --> UDS[ux/datamap-structure] - UXDD --> UDV[ux/datamap-views] - - %% Webview generations - USS --> WV1[webview/page1] - USS --> WV2[webview/page2] - USS --> WV3[webview/page3] - USS --> ROOT[webview/root] - UDV --> ROOT - - %% Optional: Show multiple pages with a note - note[...more webviews...] - USS --> note - end - - %% Styling - classDef default fill:#f9f9f9,stroke:#333,stroke-width:2px - classDef boxStyle fill:#fff,stroke:#666,stroke-width:1px - classDef noteStyle fill:#fff4e6,stroke:#d9480f,stroke-width:1px - class UP,PRD,FRD,UXSD,UXDD,DRD,DBS,DBP,BRD,USS,UDS,UDV,ROUTE,WV1,WV2,WV3,ROOT boxStyle - class note noteStyle - classDef layerStyle fill:#f4f4f4,stroke:#666,stroke-width:1px,stroke-dasharray: 5 5 - class Project_Generate_Layer layerStyle +sequenceDiagram + participant Context as BuilderContext + participant Executor as BuildSequenceExecutor + participant Handler as BuildHandler + + Context->>Context: Initialize globalContext + Context->>Context: Set global/node data + Executor->>Context: Request node execution + Context->>Handler: Run handler + Handler->>Context: Store result in nodeData + Executor-->>Context: Update execution state ``` + +# 🚀Installation + +> [!WARNING] +> adding later + +**STEP 1️⃣** + + diff --git a/assets/codefox-badger.svg b/assets/codefox-badger.svg new file mode 100644 index 00000000..c0824870 --- /dev/null +++ b/assets/codefox-badger.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + +