Caution

Still working on it, it will release soon

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.

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.

Support

Warning

adding later

Revolutionize development with this disruptive platform. Join now and set the new standard!

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

Loading

CodeFox Development Guide

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js >= 18.0.0
• PNPM 9.1.2 (npm install -g [email protected])
• Tmux >= 3.2
• Tmuxinator >= 3.0.0 (gem install tmuxinator)

Project Structure

The project consists of three main components:

codefox/
├── backend/         # NestJS backend server
├── frontend/        # Next.js frontend application
└── llm-server/     # LLM service

Installation

1. Clone the repository:

git clone <repository-url>
cd codefox

2. Install dependencies:

pnpm install

3. Set up environment variables:

# Copy and configure environment files for each service
cp backend/.env.template backend/.env
cp frontend/.env.template frontend/.env
cp llm-server/.env.template llm-server/.env

Development

Using Tmuxinator (Recommended)

The project includes a Tmuxinator configuration for easy development. This will start all services in separate windows with proper layouts:

pnpm dev:tmux

This command will create:

• Window 1: Backend server
• Window 2: Frontend development server (left) and GraphQL codegen watcher (right)
• Window 3: LLM server

Tmux Navigation:

• Ctrl+a 1/2/3 - Switch between windows
• Ctrl+a r - Restart current pane's service
• Ctrl+a d - Detach from session

Manual Development

If you prefer to run services individually:

# Start all services
pnpm dev

# Or start services individually
pnpm dev:backend    # Start backend only
cd frontend && pnpm dev  # Start frontend only
cd llm-server && pnpm dev  # Start LLM server only

Additional Commands

pnpm build          # Build all packages
pnpm lint          # Run linting
pnpm format        # Format code
pnpm test          # Run tests

GraphQL Code Generation

The frontend uses GraphQL with automatic type generation. The codegen watcher is automatically started in the Tmuxinator setup, but you can also run it manually:

cd frontend
pnpm generate:watch

Troubleshooting

If you encounter any issues:

1. Ensure all environment variables are properly set
2. Check if all required services are running
3. Clear node_modules and reinstall dependencies:

pnpm clean
pnpm install

4. For Tmuxinator issues:
   • Ensure Tmux is running version 3.2 or higher
   • Check if the session is already running: tmux ls
   • Kill existing session if needed: tmux kill-session -t codefox

License

ISC