Examples Overview
Real-world DevEx configurations and use cases for different development scenarios
Examples Overview
This section provides real-world examples of DevEx configurations for different development scenarios. Each example includes complete configuration files, setup instructions, and best practices.
Available Examples
These examples build on the concepts in our Configuration Guide. For basic setup, start with Getting Started.
Web Development
Complete frontend development environment with React, Vue, and modern tools
Backend Development
Server-side development with Node.js, Python, Go, and databases
Data Science
Python data science stack with Jupyter, pandas, and ML libraries
Mobile Development
React Native and native mobile development environment
How to Use These Examples
Each example provides:
1. Complete Configuration Files
Ready-to-use YAML files that you can copy to your ~/.devex/ directory:
# Copy an example configuration
curl -fsSL https://raw.githubusercontent.com/jameswlane/devex/main/examples/web-development.yaml > ~/.devex/web-dev.yaml
# Apply the configuration
devex config apply --file ~/.devex/web-dev.yaml
devex install2. Step-by-Step Setup Instructions
Detailed walkthrough of the setup process, including:
- Prerequisites and system requirements
- Installation commands
- Configuration explanations
- Verification steps
3. Customization Options
Guidelines for adapting the examples to your specific needs:
- Adding or removing tools
- Modifying versions
- Team-specific adjustments
4. Best Practices
Proven approaches for:
- Team collaboration
- CI/CD integration
- Environment management
- Troubleshooting
Common Patterns
Multi-Environment Setup
Most examples follow this pattern for handling different environments:
# Base configuration for all environments
applications:
development:
- name: git
default: true
- name: docker
default: true
# Development-specific tools
development:
applications:
- name: docker-compose
default: true
- name: dev-tools
default: true
# Production-specific configurations
production:
applications:
- name: monitoring-agent
default: true
security:
enabled: trueTeam Collaboration Structure
Examples include team-friendly configurations:
# Team base configuration
team:
name: "frontend-team"
tools:
editor: "vscode"
shell: "zsh"
theme: "tokyo-night"
# Role-based additions
roles:
senior-developer:
additional_tools:
- kubernetes-cli
- terraform
junior-developer:
guided_setup: true
documentation_tools:
- devdocsCross-Platform Compatibility
All examples include platform-specific configurations:
applications:
development:
- name: node
linux:
install_method: mise
install_command: node@lts
macos:
install_method: mise
install_command: node@lts
windows:
install_method: mise
install_command: node@ltsQuick Start with Examples
1. Explore Available Examples
# List all available examples
devex examples list
# Show example details
devex examples show web-development
# Preview what would be installed
devex examples preview web-development2. Apply an Example
# Apply example directly
devex examples apply web-development
# Or download and customize
devex examples download web-development --output ~/.devex/my-config.yaml
# Edit ~/.devex/my-config.yaml
devex config apply --file ~/.devex/my-config.yaml3. Combine Multiple Examples
# Combine examples for full-stack development
devex examples apply web-development backend-development
# Merge specific categories
devex examples apply web-development --category frontend
devex examples apply backend-development --category databasesExample Categories
Development Stacks
Frontend-Focused:
- React development environment
- Vue.js development setup
- Angular development stack
- Static site generation tools
Backend-Focused:
- Node.js API development
- Python web development
- Go microservices
- Java enterprise development
Full-Stack:
- MEAN/MERN stack
- JAMstack development
- Serverless development
- Microservices architecture
Specialized Environments
Data & Analytics:
- Python data science
- R statistical analysis
- Machine learning development
- Business intelligence tools
Mobile Development:
- React Native setup
- Flutter development
- Native iOS development
- Native Android development
DevOps & Infrastructure:
- Kubernetes development
- Terraform infrastructure
- Ansible automation
- Monitoring and observability
Industry-Specific
Enterprise Development:
- Java enterprise stack
- .NET development
- Security-hardened environments
- Compliance-ready setups
Startup Environment:
- Rapid prototyping tools
- Multi-language support
- Cost-optimized tooling
- Collaboration-focused setup
Contributing Examples
Have a useful DevEx configuration? Contribute it to help others!
Example Structure
examples/
├── example-name/
│ ├── README.md # Description and instructions
│ ├── devex.yaml # Main configuration
│ ├── team/ # Team variations
│ │ ├── frontend.yaml
│ │ └── backend.yaml
│ ├── environments/ # Environment-specific configs
│ │ ├── development.yaml
│ │ ├── staging.yaml
│ │ └── production.yaml
│ └── assets/ # Supporting files
│ ├── vscode-settings.json
│ └── git-hooks/Contribution Guidelines
- Complete Documentation: Include clear README with setup instructions
- Cross-Platform Support: Test on Linux, macOS, and Windows
- Security Best Practices: Follow security guidelines
- Real-World Testing: Verify the configuration works in practice
- Team Feedback: Get feedback from actual users
# Fork the repository
git clone https://github.com/yourusername/devex.git
# Create your example
mkdir -p examples/my-development-stack
cd examples/my-development-stack
# Create configuration files
# ... add your files ...
# Test the example
devex config apply --file devex.yaml --dry-run
devex examples test my-development-stack
# Submit pull request
git add .
git commit -m "Add my-development-stack example"
git push origin my-example-branchExample Best Practices:
- Start Simple: Begin with essential tools, add complexity gradually
- Document Decisions: Explain why specific tools were chosen
- Include Alternatives: Provide options for different preferences
- Test Thoroughly: Verify on clean systems and different platforms
- Keep Updated: Maintain examples as tools and versions evolve
- Real-World Focus: Base examples on actual development needs
Community Examples
Beyond the official examples, the DevEx community shares configurations:
- Company Examples: Real configurations from various companies
- Open Source Projects: Configurations from popular open source projects
- Personal Setups: Individual developer configurations
- Educational: Examples for learning and teaching
Finding Community Examples
# Search community examples
devex community search "react development"
# Browse by category
devex community browse --category "data-science"
# Install community example
devex community install awesome-python-setup --author @pythonistaGetting Help
If you need help with examples:
Example-Specific Support
When asking for help with examples:
- Specify the example you're using
- Share your modifications if any
- Include error messages in full
- Mention your platform (OS, version, etc.)
- Provide context about your development needs
Ready to explore specific examples? Choose from the categories below:
Web Development
Modern frontend development with React, Vue, and cutting-edge tools
Backend Development
Server-side development across multiple languages and frameworks
Data Science
Complete Python data science and machine learning environment
Mobile Development
Cross-platform and native mobile development setup