61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
|
# Examples Directory
|
||
|
|
|
||
|
|
**Last Updated**: 2025-01-27
|
||
|
|
**Status**: Active
|
||
|
|
|
||
|
|
This directory contains reusable code examples and sample configurations for the project.
|
||
|
|
|
||
|
|
## Example Categories
|
||
|
|
|
||
|
|
### Configuration Examples
|
||
|
|
- Environment variable examples
|
||
|
|
- Configuration file examples
|
||
|
|
- Terraform examples
|
||
|
|
|
||
|
|
### Deployment Examples
|
||
|
|
- Deployment script examples
|
||
|
|
- Kubernetes manifest examples
|
||
|
|
- Deployment workflow examples
|
||
|
|
|
||
|
|
### Integration Examples
|
||
|
|
- API usage examples
|
||
|
|
- SDK examples
|
||
|
|
- Integration code samples
|
||
|
|
|
||
|
|
## Adding Examples
|
||
|
|
|
||
|
|
1. Create example file with clear naming
|
||
|
|
2. Include comments explaining the example
|
||
|
|
3. Test the example to ensure it works
|
||
|
|
4. Reference in documentation
|
||
|
|
|
||
|
|
## Example Format
|
||
|
|
|
||
|
|
```bash
|
||
|
|
#!/bin/bash
|
||
|
|
# Example: Deploy contracts
|
||
|
|
# Description: This example shows how to deploy contracts
|
||
|
|
|
||
|
|
# Set environment variables
|
||
|
|
export RPC_URL="https://rpc.d-bis.org"
|
||
|
|
export PRIVATE_KEY="your-private-key"
|
||
|
|
|
||
|
|
# Deploy contracts
|
||
|
|
./scripts/deployment/deploy-contracts.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
## Current Examples
|
||
|
|
|
||
|
|
*Examples are embedded in documentation guides. Add standalone examples here as needed.*
|
||
|
|
|
||
|
|
## Related Documentation
|
||
|
|
|
||
|
|
- [Configuration Index](../configuration/CONFIGURATION_INDEX.md)
|
||
|
|
- [Deployment Guide](../deployment/DEPLOYMENT.md)
|
||
|
|
- [Integration Guide](../guides/INTEGRATION_GUIDE.md)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Last Updated**: 2025-01-27
|
||
|
|
|