A professional configuration generator for Cursor IDE that helps developers set up their development environment with best practices, architecture patterns, and workflow configurations.
Vibe Condom is a web-based tool that generates configuration files for Cursor IDE based on your selected preferences. It helps protect your codebase by enforcing architectural decisions, design patterns, and development practices through automated configuration.
-
Architecture Selection: Choose from various architectural patterns including:
- Monolith
- Microservices
- Serverless
- Clean Architecture
- Hexagonal Architecture
- Event-Driven Architecture
- And more...
-
Design Patterns: Implement proven design patterns:
- SOLID Principles
- Factory Pattern
- Singleton Pattern
- Observer Pattern
- Strategy Pattern
- And many others...
-
Development Practices: Enforce best practices:
- Test-Driven Development (TDD)
- Behavior-Driven Development (BDD)
- Clean Code
- Code Review
- CI/CD
- And more...
-
Git Flow: Configure your preferred Git workflow:
- GitFlow
- Trunk-Based Development
- Feature Branch Workflow
- GitHub Flow
- GitLab Flow
- And others...
-
Clone the repository:
git clone https://github.com/yourusername/vibe-condom.git
-
Open
index.htmlin your web browser. -
Select your preferred configurations from each category.
-
Click "Generate Configuration" to create your configuration file.
-
Copy the generated configuration and save it as
cursor.jsonin your project's root directory.
-
Select one or more options from each category (Architecture, Design Patterns, Development Practices, Git Flow).
-
Click the "Generate Configuration" button to view your configuration.
-
Review the generated configuration in the modal window.
-
Use the "Copy to Clipboard" button to copy the configuration.
-
Create a
cursor.jsonfile in your project's root directory and paste the configuration.
The project is automatically deployed to GitHub Pages using GitHub Actions. The deployment workflow:
- Triggers on push to the main branch
- Can be manually triggered from the Actions tab
- Deploys the site to GitHub Pages
- Provides a URL for the deployed site
To enable GitHub Pages for your repository:
- Go to your repository settings
- Navigate to the "Pages" section
- Select "GitHub Actions" as the source
- The site will be available at
https://yourusername.github.io/vibe-condom
The generated configuration file follows this structure:
{
"architecture": {
"type": "selected-architecture",
"settings": {
"scalability": true,
"maintainability": true,
"security": true
}
},
"patterns": {
"enabled": ["pattern1", "pattern2"],
"settings": {
"strictMode": true,
"documentation": true
}
},
"practices": {
"enabled": ["practice1", "practice2"],
"settings": {
"enforceStandards": true,
"codeReview": true,
"testing": true
}
},
"gitflow": {
"type": "selected-gitflow",
"settings": {
"branchNaming": true,
"mergeStrategy": "squash",
"protectedBranches": ["main", "develop"]
}
}
}Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- Cursor IDE for providing the configuration system
- The open-source community for inspiration and best practices