@dataroadinc/setup-auth/docs/README.md

CLI tool and programmatic API for automated OAuth setup across cloud platforms

# Documentation

This directory contains comprehensive documentation for the
`@dataroadinc/setup-auth` project.

## Available Guides

### [Development Guide](development.md)

Complete development setup and workflow, including:

- Prerequisites and quick start
- Project structure overview
- Environment configuration
- Testing and code quality
- Git workflow and conventional commits
- Available CLI commands
- Troubleshooting

### [Code Formatting](formatting.md)

Detailed guide for consistent code formatting:

- Prettier configuration
- VS Code/Cursor setup
- IDE configuration
- Pre-commit hooks
- Troubleshooting formatting issues

### [Markdown Formatting](markdown-formatting.md)

Comprehensive guide to markdown formatting standards:

- Line length and wrapping rules
- Spacing and structure guidelines
- File naming conventions
- Content organization
- Enforcement and tools

### [Versioning](versioning.md)

Comprehensive guide to the stateless versioning system:

- Overview of `dr-ts-versioning` package
- Available versioning commands
- How version detection works
- Changelog generation
- CI/CD integration
- Conventional commits
- Example workflows

### [Open Source Release](open-source-release.md)

Planning and status for the open source release:

- Executive summary and accomplishments
- Motivation and goals
- Changes made for open source compliance
- Implementation checklist
- Release status and readiness

### [Vercel Integration](vercel-integration.md)

Detailed guide to Vercel integration features:

- Authentication validation and API integration
- Deployment URL discovery
- Project configuration management
- OAuth integration workflow
- Error handling and troubleshooting

### [GCP Integration](gcp-integration.md)

Comprehensive guide to Google Cloud Platform integration:

- API limitations and gcloud CLI solutions
- Service account and IAM management
- OAuth client automation
- Environment variable configuration
- Organization-level OAuth client listing

### [Automation and Testing](automation-testing.md)

Overview of automation principles and testing strategies:

- Automation-first principle implementation
- What's automated vs. manual steps
- Integration test planning
- Test execution and configuration
- Continuous integration setup

### [Authentication and Workflow](authentication-workflow.md)

Guide to authentication automation and developer workflow:

- Multi-provider authentication support
- Unified login command design
- IAM propagation optimization
- Token expiration handling
- Security considerations

### [OAuth Automation](oauth-automation.md)

Comprehensive guide to OAuth automation:

- OAuth client implementation across providers
- Command separation and responsibilities
- OAuth client creation and management
- Redirect URL automation
- Full automation achievements

## Additional Resources

- **[README.md](../README.md)** - Main project documentation
- **[env.local.example](../env.local.example)** - Environment variable examples
- **[package.json](../package.json)** - Project configuration and scripts

## Getting Started

1. Start with the [Development Guide](development.md) for setup instructions
2. Review the [Code Formatting](formatting.md) guide for IDE setup
3. Check the [Markdown Formatting](markdown-formatting.md) guide for
   documentation standards
4. Review the [Versioning](versioning.md) guide for release management
5. Refer to the main [README.md](../README.md) for usage examples