diff --git a/README.md b/README.md index 01b6868..725841e 100644 --- a/README.md +++ b/README.md @@ -144,9 +144,10 @@ saac create application \ - Applications with complex builds: Up to 10+ minutes **Best Practices:** -- Always run `npm run build` or equivalent build commands locally first to catch errors -- Test your Docker Compose configuration locally before deploying -- Check your build logs if deployment fails: `saac logs --follow` +- Always run `npm run build` or equivalent build commands locally first to catch errors (if possible) +- Review your docker-compose.yml for correct port configuration (use `expose`, not `ports`) +- 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 @@ -339,7 +340,6 @@ Both volumes are persistent and survive container restarts. ### Prerequisites - Node.js 18 or higher -- Docker and Docker Compose (for local container testing) ### Setup @@ -347,27 +347,13 @@ Both volumes are persistent and survive container restarts. # Install dependencies npm install -# Run development server +# Run development server (without Docker) npm run dev ``` The application will be available at http://localhost:3000 -### Local Docker Testing - -```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 -``` +**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`. --- @@ -574,7 +560,7 @@ To contribute to this template: 1. Fork the repository 2. Create a feature branch 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 ---