Files
gremiumhub/README.md

52 lines
1.5 KiB
Markdown

# Legal Consent Hub
A comprehensive platform for digital applications, approvals, and discussions, designed for organizational workflows involving employee data processing and consent management.
## Documentation
For detailed documentation, architecture, and development guidelines, see [CLAUDE.md](./CLAUDE.md).
## CI/CD with Act
This project uses [nektos/act](https://nektosact.com/) for local workflow execution. Workflows are defined in `.github/workflows/` in GitHub Actions format.
### Running Workflows Locally
```bash
# List available workflows and jobs
act -l
# Run specific jobs
act -j frontend # Run frontend job only
act -j backend # Run backend job only
# Run all jobs for push event
act push
# Run with secrets (required for Docker push and deployment)
act push --secret-file .secrets
# Dry run to see what would execute
act -n
# Run a specific workflow file
act -W .github/workflows/pipeline.yaml
```
### Setup
1. Ensure [act](https://nektosact.com/) is installed (already available locally)
2. Copy `.secrets.example` to `.secrets` and fill in your credentials:
```bash
cp .secrets.example .secrets
# Edit .secrets with your actual tokens/keys
```
3. The `.actrc` file contains default configuration for act
### Important Notes
- **Manual Execution**: Workflows must be run manually via `act` command
- **Secrets Required**: Docker push and deployment require secrets from `.secrets` file
- **No Automation**: Unlike traditional CI/CD, act runs locally on demand
- Backend tests may fail if PostgreSQL is running on the host machine