Skip to content

A universal project template that works with the BaryoDev Skills Library to provide AI-assisted development for any project type.

License

Notifications You must be signed in to change notification settings

BaryoDev/template-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

BaryoDev Project Template

A universal project template that works with the BaryoDev Skills Library to provide AI-assisted development for any project type.

πŸš€ Quick Start

1. Create a New Project

gh repo create YourOrg/YourProject --template BaryoDev/template-project --public
cd YourProject

2. Customize for Your Project Type

Open your project in your IDE and prompt the AI:

This is a [PROJECT_TYPE] project. Update .cursorrules by fetching skills from https://github.com/BaryoDev/skills:
- [skill-name-1]
- [skill-name-2]

Then add [PROJECT_TYPE]-specific rules:
- [Rule 1]
- [Rule 2]

3. Start Coding

The AI now knows your project's rules and will assist accordingly!


πŸ“š Documentation

This template includes a pre-configured VitePress documentation site.

Run Documentation Locally

npm install
npm run docs:dev

Visit http://localhost:5173 to see your docs.

🧠 Smart Skill Loading

To optimize token consumption, this template uses BaryoDev Skills Lite by default (~2.5k tokens vs 16.5k total).

How it Works:

  1. Lite Skills: Provide high-level rules in .cursorrules for daily work.
  2. Full Skills: When you need deep expertise (e.g., "Review my API for security vulnerabilities"), ask the AI:

    "Load baryo-security skill" 3: Fetching: The AI will use ./scripts/get-skill.sh to fetch the full documentation from the Skills Library.

🧱 Intelligence Compression (baryo-compact)

As your project grows, your logs and mistakes can become too large for the AI to process effectively. This template includes a manual "Auto-Compact" feature.

  • The Command: npm run compact
  • What it does: Gathers all your historical logs and prompts the AI to distill them into a dense, high-utility .baryo/CONTEXT.md file.
  • The Result: You preserve 100% of your project's "Core Intelligence" and architectural "Whys" while saving thousands of tokens per session.

πŸ—οΈ Getting Started

Documentation Structure

  • Home (docs/index.md): Landing page with hero and features
  • Guide (docs/guide/): Getting started, installation, quick start, features
  • Reference (docs/reference/): Changelog, FAQ, migration guides

Build for Production

npm run docs:build
npm run docs:preview

The built site will be in docs/.vitepress/dist/.


πŸ“Š Workflow Diagram

flowchart TD
    Start([πŸ‘€ You: Start New Project]) --> Template[πŸ“¦ Use BaryoDev/template-project]
    Template --> Clone[πŸ”½ gh repo create MyProject --template]
    Clone --> BaseConfig[πŸ“„ Project has minimal .cursorrules<br/>- baryo-coding<br/>- baryo-testing<br/>- baryo-compliance]
    
    BaseConfig --> Decide{What type of<br/>project?}
    
    Decide -->|Android| PromptAndroid[πŸ’¬ Prompt AI:<br/>'Fetch skills for Android']
    Decide -->|iOS| PromptIOS[πŸ’¬ Prompt AI:<br/>'Fetch skills for iOS']
    Decide -->|Web App| PromptWeb[πŸ’¬ Prompt AI:<br/>'Fetch skills for Web']
    Decide -->|Library| PromptLib[πŸ’¬ Prompt AI:<br/>'Already configured!']
    
    PromptAndroid --> FetchAndroid[🌐 AI fetches from<br/>github.com/BaryoDev/skills:<br/>- webapp-testing<br/>- frontend-design]
    PromptIOS --> FetchIOS[🌐 AI fetches from<br/>github.com/BaryoDev/skills:<br/>- webapp-testing]
    PromptWeb --> FetchWeb[🌐 AI fetches from<br/>github.com/BaryoDev/skills:<br/>- baryo-architecture<br/>- webapp-testing<br/>- frontend-design]
    
    FetchAndroid --> CreateAndroid[✨ AI creates:<br/>baryo-android skill<br/>- Kotlin<br/>- Jetpack Compose<br/>- Hilt DI]
    FetchIOS --> CreateIOS[✨ AI creates:<br/>baryo-ios skill<br/>- Swift<br/>- SwiftUI<br/>- Combine]
    FetchWeb --> CreateWeb[✨ AI creates:<br/>baryo-webapp skill<br/>- React/Vue<br/>- TypeScript<br/>- Vite]
    
    CreateAndroid --> UpdateConfig[πŸ“ AI updates .cursorrules<br/>with all fetched + new skills]
    CreateIOS --> UpdateConfig
    CreateWeb --> UpdateConfig
    PromptLib --> UpdateConfig
    
    UpdateConfig --> Ready[βœ… Project Ready!<br/>AI knows all rules]
    
    Ready --> Code[πŸ‘¨β€πŸ’» Start Coding]
    Code --> AIHelp{Need AI help?}
    
    AIHelp -->|Yes| Roles{Which role?}
    AIHelp -->|No| Done([πŸŽ‰ Ship It!])
    
    Roles -->|Code| DevRole[πŸ”§ Developer Role<br/>Uses: baryo-coding]
    Roles -->|Test| QARole[πŸ§ͺ QA Role<br/>Uses: baryo-testing]
    Roles -->|Docs| WriterRole[πŸ“ Writer Role<br/>Uses: docx, pdf]
    Roles -->|Deploy| OpsRole[πŸš€ DevOps Role<br/>Uses: baryo-packaging]
    
    DevRole --> Code
    QARole --> Code
    WriterRole --> Code
    OpsRole --> Code
    
    style Start fill:#e1f5ff
    style Template fill:#fff3cd
    style BaseConfig fill:#d4edda
    style Ready fill:#d1ecf1
    style Done fill:#d4edda
    
    classDef skillRepo fill:#f8d7da,stroke:#721c24
    class FetchAndroid,FetchIOS,FetchWeb skillRepo
Loading

πŸ“š Example Prompts

Android Project

This is an Android project. Update .cursorrules by fetching these skills from https://github.com/BaryoDev/skills:
- webapp-testing (for UI automation)
- frontend-design (for Material Design)

Then add Android-specific rules:
- Use Kotlin (not Java)
- Jetpack Compose for UI
- Hilt for dependency injection
- MVVM architecture
- Coroutines for async operations

iOS Project

This is an iOS project. Update .cursorrules by fetching these skills from https://github.com/BaryoDev/skills:
- webapp-testing (for UI testing)

Then add iOS-specific rules:
- Use Swift (not Objective-C)
- SwiftUI for UI
- Combine for reactive programming
- MVVM architecture
- Async/await for concurrency

Web Application

This is a web application. Update .cursorrules by fetching these skills from https://github.com/BaryoDev/skills:
- baryo-architecture (Vertical Slices)
- webapp-testing (Browser automation)
- frontend-design (UI components)

Then add web-specific rules:
- Use TypeScript
- React with Vite
- TailwindCSS for styling
- React Query for data fetching

.NET Library

This is a .NET library. Update .cursorrules by fetching these skills from https://github.com/BaryoDev/skills:
- baryo-packaging (Manual NuGet releases)

Then add library-specific rules:
- Target .NET Standard 2.0
- Zero external dependencies
- Provide both sync and async APIs
- Include XML documentation

Machine Learning Project

This is a machine learning project. Update .cursorrules by fetching these skills from https://github.com/BaryoDev/skills:
- baryo-testing (for model validation)

Then add ML-specific rules:
- Use Python 3.11+
- PyTorch framework
- Type hints mandatory
- Reproducible experiments (seed everything)
- Document model architecture

🎭 AI Role Switching

Once configured, the AI can switch between roles based on your requests:

πŸ‘¨β€πŸ’» Developer Role

Trigger: "Add a new feature", "Refactor this code"
Uses: baryo-coding, baryo-architecture

πŸ§ͺ QA Engineer Role

Trigger: "Test this", "Write tests for..."
Uses: baryo-testing, webapp-testing

πŸ“ Technical Writer Role

Trigger: "Document this", "Create a user guide"
Uses: docx, pdf, pptx

πŸš€ DevOps Role

Trigger: "Prepare for release", "Set up CI/CD"
Uses: baryo-packaging, baryo-compliance


πŸ“– Available Skills

Browse all available skills in the BaryoDev Skills Library:

Core BaryoDev Skills

Document Skills

  • docx - Word document creation
  • pdf - PDF manipulation
  • pptx - PowerPoint generation
  • xlsx - Excel spreadsheets

Development Skills

Utility Skills


πŸ—οΈ Project Structure

template-project/
β”œβ”€β”€ .cursorrules          # AI behavior configuration
β”œβ”€β”€ .github/
β”‚   └── workflows/        # CI/CD workflows (add as needed)
β”œβ”€β”€ src/                  # Source code
β”œβ”€β”€ tests/                # Test files
β”œβ”€β”€ docs/                 # Documentation
β”œβ”€β”€ LICENSE               # MPL-2.0 License
└── README.md             # This file

πŸ›‘οΈ Safety & Security

Zero Automated Contributions. The BaryoDev ecosystem follows a strict "Safety First" policy. While the baryo-learning skill allows the AI to suggest improvements to the global skills library, no automated pull requests or pushes will ever be made to community repositories without your explicit, manual approval in the current session.

The process is always:

  1. AI identifies an improvement or fix.
  2. AI drafts the proposal locally in .baryo/skill-proposals/.
  3. AI presents the changes for your review.
  4. You provide the final "Go" signal before any PR is created.

🀝 Contributing

To add a new skill to the library:

  1. Create the skill in your project
  2. Format it as a SKILL.md file
  3. Submit a PR to BaryoDev/skills

πŸ“„ License

This template is licensed under the MPL-2.0 License.

Individual skills in the BaryoDev Skills Library may have different licenses (check each skill's directory).


πŸ†˜ Support

About

A universal project template that works with the BaryoDev Skills Library to provide AI-assisted development for any project type.

Resources

License

Stars

Watchers

Forks

Languages