tester/hireflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README: Remove local Docker testing instructions

Browse Source 
- Remove local Docker testing section (SAAC AI agents don't have Docker)
- Update best practices for AI agents without build tools
- Update contributing section to use saac deploy for testing
- Add note that AI agents should deploy directly to SAAC servers

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
ryan.gogo
2026-02-14 06:33:19 +01:00
parent bf6bb394c2
commit 82f0c75ac3
1 changed files with 7 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -144,9 +144,10 @@ saac create application \
- Applications with complex builds: Up to 10+ minutes - Applications with complex builds: Up to 10+ minutes
**Best Practices:** **Best Practices:**
- Always run `npm run build` or equivalent build commands locally first to catch errors - Always run `npm run build` or equivalent build commands locally first to catch errors (if possible)
- Test your Docker Compose configuration locally before deploying - Review your docker-compose.yml for correct port configuration (use `expose`, not `ports`)
- Check your build logs if deployment fails: `saac logs --follow` - Deploy to Start an AI Company servers and check build logs: `saac logs --follow`
- For AI agents without local build tools: Deploy directly and monitor logs for errors
### 9. Other Available Templates ### 9. Other Available Templates
@@ -339,7 +340,6 @@ Both volumes are persistent and survive container restarts.
### Prerequisites ### Prerequisites
- Node.js 18 or higher - Node.js 18 or higher
- Docker and Docker Compose (for local container testing)
### Setup ### Setup
@@ -347,27 +347,13 @@ Both volumes are persistent and survive container restarts.
# Install dependencies # Install dependencies
npm install npm install
# Run development server # Run development server (without Docker)
npm run dev npm run dev
``` ```
The application will be available at http://localhost:3000 The application will be available at http://localhost:3000
### Local Docker Testing **Note for AI Agents:** SAAC AI agents do not have Docker available. Testing should be done by deploying directly to Start an AI Company servers using `saac deploy`.
```bash
# Build and start all services
docker-compose up -d
# View logs
docker-compose logs -f
# Stop services
docker-compose down
# Stop and remove volumes (clean slate)
docker-compose down -v
```
--- ---
@@ -574,7 +560,7 @@ To contribute to this template:
1. Fork the repository 1. Fork the repository
2. Create a feature branch 2. Create a feature branch
3. Make your changes 3. Make your changes
4. Test locally with Docker Compose 4. Test by deploying with `saac deploy` to verify functionality
5. Submit a pull request 5. Submit a pull request
--- ---