@roomi-fields/grillhouse 0.0.0-stage → 0.23.0

package/cadre/templates/projet/deployment/docs/01-INSTALL.md

@@ -0,0 +1,145 @@
+# Installation Guide
+
+## Prerequisites
+
+- **Node.js**: Version 18.0.0 or higher
+- **npm**: Comes with Node.js (or use yarn/pnpm)
+- **Git**: For cloning the repository (if installing from source)
+
+### Verify Prerequisites
+
+```bash
+node --version   # Should be >= 18.0.0
+npm --version    # Should be >= 8.0.0
+```
+
+## Installation Methods
+
+### Method 1: npm (Recommended)
+
+Install globally:
+
+```bash
+npm install -g @your-scope/project-name
+```
+
+Or install locally in your project:
+
+```bash
+npm install @your-scope/project-name
+```
+
+### Method 2: From Source
+
+Clone and build:
+
+```bash
+# Clone the repository
+git clone https://github.com/your-username/project-name.git
+cd project-name
+
+# Install dependencies
+npm install
+
+# Build
+npm run build
+```
+
+## Post-Installation
+
+### 1. Create Configuration
+
+```bash
+# Copy example configuration
+cp .env.example .env
+
+# Edit with your settings
+nano .env  # or your preferred editor
+```
+
+### 2. Verify Installation
+
+```bash
+# Check version
+project-name --version
+
+# Or run directly
+npm start
+```
+
+### 3. Test the Application
+
+```bash
+# Run tests
+npm test
+
+# Check health endpoint (if applicable)
+curl http://localhost:3000/health
+```
+
+## Updating
+
+### npm Installation
+
+```bash
+npm update -g @your-scope/project-name
+```
+
+### Source Installation
+
+```bash
+git pull origin main
+npm install
+npm run build
+```
+
+## Uninstalling
+
+### npm Installation
+
+```bash
+npm uninstall -g @your-scope/project-name
+```
+
+### Source Installation
+
+```bash
+rm -rf /path/to/project-name
+```
+
+## Troubleshooting Installation
+
+### Permission Errors (npm global)
+
+```bash
+# Option 1: Use sudo (Linux/macOS)
+sudo npm install -g @your-scope/project-name
+
+# Option 2: Fix npm permissions (recommended)
+npm config set prefix ~/.npm-global
+export PATH=~/.npm-global/bin:$PATH
+```
+
+### Build Errors
+
+```bash
+# Clear npm cache
+npm cache clean --force
+
+# Remove node_modules and reinstall
+rm -rf node_modules package-lock.json
+npm install
+```
+
+### Node Version Issues
+
+```bash
+# Using nvm to switch Node versions
+nvm install 20
+nvm use 20
+```
+
+## Next Steps
+
+- [Configuration Guide](02-CONFIGURATION.md)
+- [API Reference](03-API.md)

package/cadre/templates/projet/deployment/docs/02-CONFIGURATION.md

@@ -0,0 +1,117 @@
+# Configuration Guide
+
+## Environment Variables
+
+All configuration is done through environment variables. Create a `.env` file in the project root.
+
+### Required Variables
+
+| Variable | Description | Example |
+|----------|-------------|---------|
+| `NODE_ENV` | Environment mode | `production` |
+
+### Optional Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `PORT` | Server port | `3000` |
+| `LOG_LEVEL` | Logging verbosity | `info` |
+
+## Configuration File
+
+### .env Template
+
+```bash
+# Environment
+NODE_ENV=production
+
+# Server
+PORT=3000
+
+# Logging
+LOG_LEVEL=info
+
+# Add your configuration here
+```
+
+## Environment-Specific Configuration
+
+### Development
+
+```bash
+NODE_ENV=development
+LOG_LEVEL=debug
+PORT=3000
+```
+
+### Production
+
+```bash
+NODE_ENV=production
+LOG_LEVEL=warn
+PORT=8080
+```
+
+### Test
+
+```bash
+NODE_ENV=test
+LOG_LEVEL=error
+PORT=3001
+```
+
+## Advanced Configuration
+
+### Logging Levels
+
+| Level | Description | When to Use |
+|-------|-------------|-------------|
+| `debug` | Detailed debug info | Development |
+| `info` | General information | Default |
+| `warn` | Warning messages | Production |
+| `error` | Error messages only | Minimal logging |
+
+### PM2 Configuration
+
+The `ecosystem.config.cjs` file configures PM2 daemon mode:
+
+```javascript
+module.exports = {
+  apps: [{
+    name: 'project-name',
+    script: 'dist/index.js',
+    instances: 1,
+    autorestart: true,
+    max_memory_restart: '1G',
+    env: {
+      NODE_ENV: 'production',
+      PORT: 3000
+    }
+  }]
+};
+```
+
+## Validation
+
+Configuration is validated at startup. Invalid configuration will prevent the application from starting.
+
+### Common Validation Errors
+
+```
+Invalid environment configuration:
+- PORT: Expected number, received string
+```
+
+**Solution**: Ensure all required variables are set with correct types.
+
+## Security Considerations
+
+1. **Never commit `.env` files** to version control
+2. **Use strong secrets** in production
+3. **Limit log verbosity** in production
+4. **Rotate secrets** regularly
+
+## Next Steps
+
+- [API Reference](03-API.md)
+- [Troubleshooting](04-TROUBLESHOOTING.md)

package/cadre/templates/projet/deployment/docs/03-API.md

@@ -0,0 +1,264 @@
+# API Reference
+
+## Overview
+
+Base URL: `http://localhost:3000`
+
+All endpoints return JSON responses.
+
+## Authentication
+
+> Add authentication details here if applicable
+
+## Endpoints
+
+### Health Check
+
+Check if the server is running.
+
+**Request:**
+```http
+GET /health
+```
+
+**Response:**
+```json
+{
+  "status": "ok",
+  "version": "1.0.0",
+  "timestamp": "2024-01-01T00:00:00.000Z"
+}
+```
+
+**cURL Example:**
+```bash
+curl http://localhost:3000/health
+```
+
+---
+
+### Example Resource
+
+#### List Resources
+
+**Request:**
+```http
+GET /api/resources
+```
+
+**Query Parameters:**
+| Parameter | Type | Description | Default |
+|-----------|------|-------------|---------|
+| `limit` | number | Max items to return | 10 |
+| `offset` | number | Items to skip | 0 |
+
+**Response:**
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "name": "Resource 1"
+    }
+  ],
+  "total": 100,
+  "limit": 10,
+  "offset": 0
+}
+```
+
+**cURL Example:**
+```bash
+curl "http://localhost:3000/api/resources?limit=10&offset=0"
+```
+
+---
+
+#### Get Resource by ID
+
+**Request:**
+```http
+GET /api/resources/:id
+```
+
+**Path Parameters:**
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id` | string | Resource ID |
+
+**Response:**
+```json
+{
+  "id": "1",
+  "name": "Resource 1",
+  "createdAt": "2024-01-01T00:00:00.000Z"
+}
+```
+
+**cURL Example:**
+```bash
+curl http://localhost:3000/api/resources/1
+```
+
+---
+
+#### Create Resource
+
+**Request:**
+```http
+POST /api/resources
+Content-Type: application/json
+```
+
+**Body:**
+```json
+{
+  "name": "New Resource"
+}
+```
+
+**Response:**
+```json
+{
+  "id": "2",
+  "name": "New Resource",
+  "createdAt": "2024-01-01T00:00:00.000Z"
+}
+```
+
+**cURL Example:**
+```bash
+curl -X POST http://localhost:3000/api/resources \
+  -H "Content-Type: application/json" \
+  -d '{"name": "New Resource"}'
+```
+
+---
+
+#### Update Resource
+
+**Request:**
+```http
+PUT /api/resources/:id
+Content-Type: application/json
+```
+
+**Body:**
+```json
+{
+  "name": "Updated Resource"
+}
+```
+
+**Response:**
+```json
+{
+  "id": "1",
+  "name": "Updated Resource",
+  "updatedAt": "2024-01-01T00:00:00.000Z"
+}
+```
+
+**cURL Example:**
+```bash
+curl -X PUT http://localhost:3000/api/resources/1 \
+  -H "Content-Type: application/json" \
+  -d '{"name": "Updated Resource"}'
+```
+
+---
+
+#### Delete Resource
+
+**Request:**
+```http
+DELETE /api/resources/:id
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "message": "Resource deleted"
+}
+```
+
+**cURL Example:**
+```bash
+curl -X DELETE http://localhost:3000/api/resources/1
+```
+
+---
+
+## Error Responses
+
+All errors follow this format:
+
+```json
+{
+  "error": {
+    "code": "ERROR_CODE",
+    "message": "Human-readable error message"
+  }
+}
+```
+
+### Error Codes
+
+| Code | HTTP Status | Description |
+|------|-------------|-------------|
+| `VALIDATION_ERROR` | 400 | Invalid request data |
+| `AUTHENTICATION_ERROR` | 401 | Not authenticated |
+| `AUTHORIZATION_ERROR` | 403 | Not authorized |
+| `NOT_FOUND` | 404 | Resource not found |
+| `CONFLICT_ERROR` | 409 | Resource conflict |
+| `RATE_LIMIT_ERROR` | 429 | Too many requests |
+| `INTERNAL_ERROR` | 500 | Server error |
+
+### Error Examples
+
+**Validation Error:**
+```json
+{
+  "error": {
+    "code": "VALIDATION_ERROR",
+    "message": "Name is required"
+  }
+}
+```
+
+**Not Found:**
+```json
+{
+  "error": {
+    "code": "NOT_FOUND",
+    "message": "Resource not found"
+  }
+}
+```
+
+## Rate Limiting
+
+> Add rate limiting details here if applicable
+
+## Pagination
+
+List endpoints support pagination:
+
+```http
+GET /api/resources?limit=10&offset=20
+```
+
+Response includes pagination info:
+```json
+{
+  "data": [...],
+  "total": 100,
+  "limit": 10,
+  "offset": 20
+}
+```
+
+## Next Steps
+
+- [Troubleshooting](04-TROUBLESHOOTING.md)