Demo Repositories

Demo Repositories

Crodox provides two public demonstration repositories to help you learn the platform and validate your templates.

---

Overview

The demo repositories are hosted publicly on GitHub under the crodox-app organization and can be used for testing, learning, and proof-of-concept work.

Start here: Open the Crodox app at https://crodox-app.com/home to begin.

---

simpleDemo

Repository: https://github.com/crodox-app/simpleDemo

The simpleDemo repository is a minimal testbed for Crodox syntax and parsing fundamentals.

Purpose

• Test basic Crodox grammar syntax recognition
• Validate parsing behavior on simple pseudo-code files
• Experiment with detection mechanisms before scaling to complex languages
• Serve as a foundation for template development

Contents

• Simple text-based pseudo-code files (.txt)
• Example test files: testFile.txt, refFile.txt, bridgeTest.txt
• Minimal folder structure for navigation practice

When to Use

1. Learning Crodox Syntax - Write a simple grammar and test it against testFile.txt
2. Validating Templates - Before using your grammar on a real project, test it on simpleDemo
3. Debugging - When a grammar behaves unexpectedly, test it on simpleDemo first

Getting Started with simpleDemo

1. Open the app at https://crodox-app.com/home
2. Sign in and authorize GitHub access
3. Create a new template (e.g., my_test_grammar)
4. Write a simple grammar:

   <~ file.txt ~>
   <: define :> <<name>>
   <: function :> <<name>> <- variable ->
   

5. Create a workbench using simpleDemo as the source repository
6. Review extracted components and patches

---

angularTemp

Repository: https://github.com/crodox-app/angularTemp

The angularTemp repository is a production-ready Angular template that demonstrates extracting and reintegrating sub-components of a real-world application.

Purpose

• Showcase best-practice Crodox workflows on a complete application
• Provide a working template (.crodox.json) for import and extension
• Demonstrate modularization and component extraction at scale
• Serve as a reference for building your own framework-specific templates

Contents

• Complete Angular Material Dashboard application
• Pre-configured .crodox.json grammar definition
• Typical project structure: src/app/, component files, module definitions
• Real TypeScript/HTML/SCSS assets

When to Use

1. Learning Template Structure - Import angularTemp's .crodox.json and study how it extracts Angular components
2. Building Your Template - Use angularTemp as a base and customize it for your project
3. Production Testing - Test your Crodox workflow on a real application before analyzing your own projects

Getting Started with angularTemp

1. Open the app at https://crodox-app.com/home
2. Create a new template and select Import Template from Repository
3. Choose angularTemp as the source
4. The .crodox.json is loaded into your editor—study the grammar structure
5. Modify the template for your needs, or use it as-is to analyze other Angular projects
6. Create a workbench to test extraction and patch generation

---

Comparison

Aspect	simpleDemo	angularTemp
Complexity	Minimal	Real-world
Language	Pseudo-code	TypeScript/Angular
Use Case	Learning & validation	Production template
Grammar	Write your own	Import & customize
Scale	Small files	Full application

---

Recommended Learning Path

1. Start with simpleDemo - Create a simple grammar and understand Crodox syntax
2. Explore angularTemp - Import the existing template and see how it works
3. Combine Both - Create a template based on angularTemp's patterns, test it on simpleDemo
4. Apply to Your Code - Use your template on your own repositories

---

Repository Requirements

Both repositories are marked as Template Repositories in GitHub, which is required to use them with Crodox.

For more information on marking your own repositories as templates, see GitHub-Repository-Setup.

---

Next Steps

• Workflow-SimpleDemo - Step-by-step: testing grammar with simpleDemo
• Workflow-AngularTemplate - Step-by-step: building a template from angularTemp
• Workflow-End-to-End - Complete journey from sign-up to PR generation

---

Official App: https://crodox-app.com/home