openwork-agent 1.0.0

package/src/templates/common/README.md.hbs

@@ -0,0 +1,358 @@
+# {{pascalCase projectName}}
+
+{{description}}
+
+## 🚀 Features
+
+- ✅ RESTful API
+- ✅ Database integration with {{database}}
+- ✅ Input validation
+- ✅ Error handling
+- ✅ CORS support
+- ✅ Logging
+- ✅ Health check endpoint
+{{#if includeDocker}}
+- ✅ Docker support
+{{/if}}
+{{#if includeTests}}
+- ✅ Unit tests
+{{/if}}
+
+## 🛠️ Technology Stack
+
+- **Framework**: {{#if framework}}{{framework}}{{else}}{{technology}}{{/if}}
+- **Database**: {{#if database}}{{database}}{{else}}None{{/if}}
+- **Language**: {{technology}}
+- **Platform**: Cross-platform
+
+## 📋 Prerequisites
+
+{{#if (eq technology "node")}}
+- Node.js >= 14.0.0
+- npm or yarn
+{{/if}}
+{{#if (eq technology "python")}}
+- Python >= 3.8
+- pip
+{{/if}}
+{{#if (eq technology "java")}}
+- Java >= 8
+- Maven >= 3.6
+{{/if}}
+{{#if (eq technology "go")}}
+- Go >= 1.19
+{{/if}}
+{{#if (eq technology "rust")}}
+- Rust >= 1.70
+- Cargo
+{{/if}}
+{{#if (eq technology "php")}}
+- PHP >= 7.4
+- Composer
+{{/if}}
+{{#if database}}
+- {{database}} database
+{{/if}}
+
+## 🚀 Quick Start
+
+### 1. Clone the repository
+
+\`\`\`bash
+git clone <repository-url>
+cd {{projectName}}
+\`\`\`
+
+### 2. Install dependencies
+
+{{#if (eq technology "node")}}
+\`\`\`bash
+npm install
+# or
+yarn install
+\`\`\`
+{{/if}}
+{{#if (eq technology "python")}}
+\`\`\`bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\\Scripts\\activate
+pip install -r requirements.txt
+\`\`\`
+{{/if}}
+{{#if (eq technology "java")}}
+\`\`\`bash
+mvn clean install
+\`\`\`
+{{/if}}
+{{#if (eq technology "go")}}
+\`\`\`bash
+go mod download
+\`\`\`
+{{/if}}
+{{#if (eq technology "rust")}}
+\`\`\`bash
+cargo build
+\`\`\`
+{{/if}}
+{{#if (eq technology "php")}}
+\`\`\`bash
+composer install
+\`\`\`
+{{/if}}
+
+### 3. Environment setup
+
+\`\`\`bash
+cp .env.example .env
+# Edit .env with your configuration
+\`\`\`
+
+### 4. Run the application
+
+{{#if (eq technology "node")}}
+\`\`\`bash
+# Development mode
+npm run dev
+
+# Production mode
+npm start
+\`\`\`
+{{/if}}
+{{#if (eq technology "python")}}
+\`\`\`bash
+uvicorn main:app --reload
+# or
+python main.py
+\`\`\`
+{{/if}}
+{{#if (eq technology "java")}}
+\`\`\`bash
+mvn spring-boot:run
+\`\`\`
+{{/if}}
+{{#if (eq technology "go")}}
+\`\`\`bash
+go run main.go
+\`\`\`
+{{/if}}
+{{#if (eq technology "rust")}}
+\`\`\`bash
+cargo run
+\`\`\`
+{{/if}}
+{{#if (eq technology "php")}}
+\`\`\`bash
+php artisan serve
+\`\`\`
+{{/if}}
+
+### 5. Health check
+
+Visit \`\`\`http://localhost:3000/health\`\`\` to verify the API is running.
+
+## 📡 API Documentation
+
+### Base URL
+\`\`\`
+http://localhost:3000/api
+\`\`\`
+
+### Endpoints
+
+#### Users
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/users` | Get all users |
+| GET | `/users/:id` | Get user by ID |
+| POST | `/users` | Create new user |
+| PUT | `/users/:id` | Update user |
+| DELETE | `/users/:id` | Delete user |
+
+#### Health Check
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/health` | Check API status |
+
+### Example Request
+
+\`\`\`bash
+# Create a new user
+curl -X POST http://localhost:3000/api/users \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "name": "John Doe",
+    "email": "john@example.com",
+    "age": 30
+  }'
+\`\`\`
+
+## 🧪 Testing
+
+{{#if includeTests}}
+\`\`\`bash
+{{#if (eq technology "node")}}
+npm test
+{{/if}}
+{{#if (eq technology "python")}}
+pytest
+{{/if}}
+{{#if (eq technology "java")}}
+mvn test
+{{/if}}
+{{#if (eq technology "go")}}
+go test ./...
+{{/if}}
+{{#if (eq technology "rust")}}
+cargo test
+{{/if}}
+{{#if (eq technology "php")}}
+composer test
+{{/if}}
+\`\`\`
+{{else}}
+Tests are not included in this template. To add tests, create a test directory and set up your testing framework.
+{{/if}}
+
+## 🐳 Docker
+
+{{#if includeDocker}}
+### Using Docker Compose
+
+\`\`\`bash
+docker-compose up -d
+\`\`\`
+
+### Building the Docker image
+
+\`\`\`bash
+docker build -t {{projectName}} .
+docker run -p 3000:3000 {{projectName}}
+\`\`\`
+{{else}}
+Docker support was not included. To add Docker, create a Dockerfile and docker-compose.yml.
+{{/if}}
+
+## 📁 Project Structure
+
+\`\`\`
+{{projectName}}/
+├── src/                    # Source code
+│   ├── controllers/        # Route controllers
+│   ├── models/            # Data models
+│   ├── routes/            # API routes
+│   ├── middleware/        # Express middleware
+│   ├── services/          # Business logic
+│   ├── utils/             # Utility functions
+│   └── config/            # Configuration files
+{{#if (eq technology "node")}}
+├── tests/                 # Test files
+├── docs/                  # Documentation
+├── package.json           # Node.js dependencies
+├── tsconfig.json          # TypeScript configuration
+{{/if}}
+{{#if (eq technology "python")}}
+├── tests/                 # Test files
+├── requirements.txt       # Python dependencies
+├── setup.py              # Package setup
+{{/if}}
+{{#if (eq technology "java")}}
+├── src/main/java/        # Java source code
+├── src/test/java/        # Test files
+├── pom.xml               # Maven configuration
+{{/if}}
+{{#if (eq technology "go")}}
+├── internal/             # Internal packages
+├── pkg/                  # Public packages
+├── cmd/                  # Main applications
+├── api/                  # API definitions
+├── go.mod                # Go modules
+{{/if}}
+{{#if (eq technology "rust")}}
+├── src/                  # Source code
+├── tests/                # Integration tests
+├── Cargo.toml            # Cargo configuration
+{{/if}}
+{{#if (eq technology "php")}}
+├── app/                  # Application code
+├── database/migrations/  # Database migrations
+├── routes/               # API routes
+├── composer.json         # PHP dependencies
+{{/if}}
+├── .env.example           # Environment template
+├── .gitignore            # Git ignore file
+├── README.md             # This file
+{{#if includeDocker}}
+├── Dockerfile            # Docker configuration
+├── docker-compose.yml    # Docker Compose
+{{/if}}
+└── ...                   # Other files
+\`\`\`
+
+## 🔧 Configuration
+
+The application can be configured using environment variables. Copy \`.env.example\` to \`.env\` and modify the values as needed.
+
+### Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| PORT | Server port | 3000 |
+| DATABASE_URL | Database connection string | - |
+| DB_NAME | Database name | {{projectName}} |
+| JWT_SECRET | JWT secret key | - |
+| CORS_ORIGINS | Allowed CORS origins | * |
+
+## 🚀 Deployment
+
+### Heroku
+
+\`\`\`bash
+heroku create your-app-name
+git push heroku main
+\`\`\`
+
+### Vercel
+
+\`\`\`bash
+npm i -g vercel
+vercel --prod
+\`\`\`
+
+### Railway
+
+\`\`\`bash
+railway login
+railway init
+railway up
+\`\`\`
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch (\`git checkout -b feature/amazing-feature\`)
+3. Commit your changes (\`git commit -m 'Add some amazing feature'\`)
+4. Push to the branch (\`git push origin feature/amazing-feature\`)
+5. Open a Pull Request
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Built with ❤️ using [OpenWork Agent](https://github.com/your-repo/openwork-agent)
+- Thanks to all the amazing open-source libraries that made this possible
+
+## 📞 Support
+
+If you have any questions or need help, please:
+
+1. Check the documentation
+2. Search existing issues
+3. Create a new issue with detailed information
+
+---
+
+**Built with ❤️ by OpenWork Agent**