@roomi-fields/grillhouse 0.0.0-stage → 0.23.0

package/cadre/templates/projet/CONTRIBUTING.md

@@ -0,0 +1,243 @@
+# Contributing Guide
+
+Thank you for your interest in contributing to this project! This guide will help you get started.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Making Changes](#making-changes)
+- [Commit Guidelines](#commit-guidelines)
+- [Pull Request Process](#pull-request-process)
+- [Coding Standards](#coding-standards)
+- [Testing](#testing)
+- [Documentation](#documentation)
+
+## Code of Conduct
+
+Please be respectful and constructive in all interactions. We welcome contributors of all backgrounds and experience levels.
+
+## Getting Started
+
+1. **Fork the repository** on GitHub
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/YOUR-USERNAME/project-name.git
+   cd project-name
+   ```
+3. **Add the upstream remote**:
+   ```bash
+   git remote add upstream https://github.com/ORIGINAL-OWNER/project-name.git
+   ```
+
+## Development Setup
+
+### Prerequisites
+
+- Node.js >= 18.0.0
+- npm, yarn, or pnpm
+- Git
+
+### Installation
+
+```bash
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Run tests to verify setup
+npm test
+```
+
+### Development Commands
+
+| Command | Description |
+|---------|-------------|
+| `npm run dev` | Start development mode with watch |
+| `npm run build` | Build for production |
+| `npm test` | Run test suite |
+| `npm run lint` | Check code style |
+| `npm run lint:fix` | Fix code style issues |
+| `npm run format` | Format code with Prettier |
+
+## Making Changes
+
+### Create a Branch
+
+```bash
+# Update main branch
+git checkout main
+git pull upstream main
+
+# Create a new branch
+git checkout -b feature/your-feature-name
+```
+
+### Branch Naming Convention
+
+- `feature/` - New features
+- `fix/` - Bug fixes
+- `docs/` - Documentation changes
+- `refactor/` - Code refactoring
+- `test/` - Test additions or modifications
+
+## Commit Guidelines
+
+We follow [Conventional Commits](https://www.conventionalcommits.org/) specification.
+
+### Commit Message Format
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### Types
+
+| Type | Description |
+|------|-------------|
+| `feat` | New feature |
+| `fix` | Bug fix |
+| `docs` | Documentation |
+| `style` | Code style (formatting, semicolons, etc.) |
+| `refactor` | Code refactoring |
+| `perf` | Performance improvement |
+| `test` | Adding or modifying tests |
+| `chore` | Maintenance tasks |
+
+### Examples
+
+```bash
+# Feature
+git commit -m "feat(auth): add OAuth2 support"
+
+# Bug fix
+git commit -m "fix(api): handle null response correctly"
+
+# Documentation
+git commit -m "docs: update installation instructions"
+
+# Breaking change
+git commit -m "feat!: change API response format
+
+BREAKING CHANGE: response.data is now response.result"
+```
+
+## Pull Request Process
+
+1. **Update your branch** with the latest main:
+   ```bash
+   git fetch upstream
+   git rebase upstream/main
+   ```
+
+2. **Push your changes**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+3. **Open a Pull Request** on GitHub
+
+4. **Fill out the PR template** with:
+   - Summary of changes
+   - Related issues
+   - Testing performed
+   - Screenshots (if applicable)
+
+5. **Wait for review** and address any feedback
+
+### PR Checklist
+
+- [ ] Code follows project style guidelines
+- [ ] Tests pass locally
+- [ ] Documentation updated if needed
+- [ ] Commit messages follow conventions
+- [ ] No unnecessary files included
+
+## Coding Standards
+
+### TypeScript
+
+- Use strict TypeScript settings
+- Prefer `const` over `let`
+- Use explicit return types for public functions
+- Avoid `any` type when possible
+
+### Formatting
+
+- Use Prettier for code formatting
+- 2 spaces for indentation
+- Single quotes for strings
+- Trailing commas in multi-line structures
+
+### Naming Conventions
+
+| Type | Convention | Example |
+|------|------------|---------|
+| Files | kebab-case | `user-service.ts` |
+| Classes | PascalCase | `UserService` |
+| Functions | camelCase | `getUserById` |
+| Constants | UPPER_SNAKE | `MAX_RETRIES` |
+| Interfaces | PascalCase | `UserConfig` |
+| Types | PascalCase | `UserId` |
+
+## Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run with coverage
+npm run test:coverage
+
+# Run specific test file
+npm test -- path/to/test.spec.ts
+```
+
+### Writing Tests
+
+- Place tests next to source files (`*.spec.ts`) or in `tests/` directory
+- Use descriptive test names
+- Follow Arrange-Act-Assert pattern
+- Mock external dependencies
+
+### Test Coverage
+
+- Aim for >80% code coverage
+- Focus on testing business logic
+- Don't test framework code
+
+## Documentation
+
+### Code Comments
+
+- Write self-documenting code
+- Add comments for complex logic
+- Use JSDoc for public APIs
+
+### README Updates
+
+- Update README for new features
+- Include usage examples
+- Document configuration options
+
+### Changelog
+
+- Document changes in CHANGELOG.md
+- Follow Keep a Changelog format
+- Link to relevant issues/PRs
+
+## Questions?
+
+- Open an [Issue](https://github.com/OWNER/project-name/issues) for bugs
+- Start a [Discussion](https://github.com/OWNER/project-name/discussions) for questions
+
+Thank you for contributing!

package/cadre/templates/projet/CREDITS.md

@@ -0,0 +1,41 @@
+# Credits
+
+## Author
+
+**[Your Name]**
+- GitHub: [@your-username](https://github.com/your-username)
+- Email: your.email@example.com
+
+## Contributors
+
+Thanks to everyone who has contributed to this project!
+
+<!-- Add contributors here -->
+<!-- - [@contributor](https://github.com/contributor) - Description of contribution -->
+
+## Acknowledgments
+
+This project was inspired by and/or uses code from:
+
+- [Project/Library Name](link) - Description of how it helped
+- [Another Project](link) - Description
+
+## Third-Party Libraries
+
+This project uses the following open-source libraries:
+
+| Library | License | Purpose |
+|---------|---------|---------|
+| [TypeScript](https://www.typescriptlang.org/) | Apache-2.0 | Language |
+| [Vitest](https://vitest.dev/) | MIT | Testing |
+| [ESLint](https://eslint.org/) | MIT | Linting |
+| [Prettier](https://prettier.io/) | MIT | Formatting |
+
+## Special Thanks
+
+- The open-source community for amazing tools and libraries
+- Everyone who has reported bugs, suggested features, or provided feedback
+
+---
+
+Want to be listed here? [Contribute to the project!](CONTRIBUTING.md)

package/cadre/templates/projet/README.md

@@ -0,0 +1,152 @@
+# Project Name
+
+[![npm version](https://img.shields.io/npm/v/@your-scope/project-name.svg)](https://www.npmjs.com/package/@your-scope/project-name)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js Version](https://img.shields.io/node/v/@your-scope/project-name.svg)](https://nodejs.org)
+[![CI](https://github.com/your-username/project-name/actions/workflows/ci.yml/badge.svg)](https://github.com/your-username/project-name/actions/workflows/ci.yml)
+
+A brief description of what this project does and who it's for.
+
+## Features
+
+- Feature 1
+- Feature 2
+- Feature 3
+
+## Installation
+
+```bash
+# Using npm
+npm install @your-scope/project-name
+
+# Using yarn
+yarn add @your-scope/project-name
+
+# Using pnpm
+pnpm add @your-scope/project-name
+```
+
+## Quick Start
+
+```typescript
+import { something } from '@your-scope/project-name';
+
+// Example usage
+const result = something();
+console.log(result);
+```
+
+## Usage
+
+### Basic Usage
+
+```typescript
+// Basic example
+```
+
+### Advanced Usage
+
+```typescript
+// Advanced example
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable   | Description | Default   |
+| ---------- | ----------- | --------- |
+| `VAR_NAME` | Description | `default` |
+
+### Configuration File
+
+Create a `.config.json` file in your project root:
+
+```json
+{
+  "option1": "value1",
+  "option2": "value2"
+}
+```
+
+## API Reference
+
+### `functionName(param)`
+
+Description of the function.
+
+**Parameters:**
+
+- `param` (Type): Description
+
+**Returns:**
+
+- `ReturnType`: Description
+
+**Example:**
+
+```typescript
+const result = functionName(param);
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js >= 18.0.0
+- npm, yarn, or pnpm
+
+### Setup
+
+```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
+
+# Run tests
+npm test
+```
+
+### Available Scripts
+
+| Script                         | Description                                                                                                                                                                                                                                                                                                                                          |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `npm run build`                | Compile TypeScript to JavaScript                                                                                                                                                                                                                                                                                                                     |
+| `npm run dev`                  | Run in development mode with watch                                                                                                                                                                                                                                                                                                                   |
+| `npm test`                     | Build, then run the tests (Turborepo; an unchanged task is replayed from its cache); `npm test -- <paths>` plays the paths written from the root, each in its package, its tests played again once what they import changes                                                                                                                          |
+| `npm run test:forcer`          | The same, every task run for real; with paths, the tests named run for real, their builds replayed from the cache                                                                                                                                                                                                                                    |
+| `npm run verifier`             | Build, then run the frame's guards, the project's own (`gardes`) and the tests beside each other (what the integration and the CI run), measured against the last green: a package played again runs the tests Vitest relates to the files changed since; 0 green, 1 red, 75 « à repasser » (a failure of duration under load, played again at rest) |
+| `npm run verifier -- --tout`   | The complete pass: every test run for real, never measured against the last green (what the night runs)                                                                                                                                                                                                                                              |
+| `npm run verifier -- --gardes` | The guards alone (the frame's and the project's), same verdict: what the reviewer runs on the ticket's copy                                                                                                                                                                                                                                          |
+| `npm run lint`                 | Run ESLint                                                                                                                                                                                                                                                                                                                                           |
+| `npm run format`               | Format code with Prettier                                                                                                                                                                                                                                                                                                                            |
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'feat: add 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
+
+- [Dependency 1](link) - Description
+- [Dependency 2](link) - Description
+
+## Support
+
+- Create an [Issue](https://github.com/your-username/project-name/issues) for bug reports
+- Start a [Discussion](https://github.com/your-username/project-name/discussions) for questions

package/cadre/templates/projet/_gitignore

@@ -0,0 +1,91 @@
+# Dependencies
+node_modules/
+.pnpm-store/
+
+# Build output
+dist/
+*.tsbuildinfo
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# IDE and editors
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.project
+.classpath
+.settings/
+
+# OS files
+.DS_Store
+Thumbs.db
+Desktop.ini
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Test coverage
+coverage/
+.nyc_output/
+
+# Cache
+.cache/
+.eslintcache
+.prettiercache
+
+# Local data directories
+data/
+Data/
+.local/
+
+# Temporary files
+tmp/
+temp/
+*.tmp
+*.temp
+
+# Package manager locks (keep one, remove others)
+# package-lock.json  # Keep if using npm
+# yarn.lock          # Keep if using yarn
+# pnpm-lock.yaml     # Keep if using pnpm
+
+# Build artifacts
+*.tgz
+*.tar.gz
+
+# Local scripts (not for distribution)
+publish/
+scripts/local/
+
+# Runtime data
+pids/
+*.pid
+*.seed
+*.pid.lock
+
+# Beads / Dolt files (added by bd init)
+.dolt/
+*.db
+.beads-credential-key
+.beads/proxieddb/
+
+# Claude Code local settings and caches
+.claude/settings.local.json
+.rtfm/
+.codegraph/
+
+# Agent copies (one worktree per ticket) and their session logs
+.claude/worktrees/
+
+# Turborepo: its local cache and its runs
+.turbo/

package/cadre/templates/projet/_npmignore

@@ -0,0 +1,46 @@
+# Source files (we publish compiled dist/)
+src/
+
+# Tests
+tests/
+**/*.test.ts
+**/*.spec.ts
+coverage/
+.nyc_output/
+
+# Development files
+.github/
+.claude/
+.vscode/
+.idea/
+
+# Configuration files (dev only)
+tsconfig.json
+.eslintrc*
+.prettierrc*
+vitest.config.*
+ecosystem.config.*
+
+# Documentation (except what's in files array)
+deployment/
+docs/internal/
+
+# Local scripts
+publish/
+scripts/
+
+# Environment and local data
+.env*
+data/
+logs/
+
+# Build artifacts
+*.tsbuildinfo
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Git
+.git/
+.gitignore

package/cadre/templates/projet/deployment/README.md

@@ -0,0 +1,98 @@
+# Deployment Documentation
+
+This directory contains deployment guides and scripts for the project.
+
+## Structure
+
+```
+deployment/
+├── README.md           # This file
+├── docs/               # Detailed documentation
+│   ├── 01-INSTALL.md       # Installation guide
+│   ├── 02-CONFIGURATION.md # Configuration options
+│   ├── 03-API.md           # API reference
+│   └── 04-TROUBLESHOOTING.md # Common issues
+└── scripts/            # Deployment scripts
+    ├── install.ps1         # Installation script
+    ├── start.ps1           # Start server
+    ├── stop.ps1            # Stop server
+    └── test.ps1            # Test endpoints
+```
+
+## Quick Start
+
+### 1. Installation
+
+```bash
+npm install @your-scope/project-name
+```
+
+Or run the installation script:
+
+```powershell
+.\deployment\scripts\install.ps1
+```
+
+### 2. Configuration
+
+Copy the environment template:
+
+```bash
+cp .env.example .env
+```
+
+Edit `.env` with your settings.
+
+### 3. Start the Application
+
+```bash
+npm start
+```
+
+Or use the daemon mode:
+
+```bash
+npm run daemon:start
+```
+
+### 4. Verify
+
+```bash
+curl http://localhost:3000/health
+```
+
+## Documentation Index
+
+| Document | Description |
+|----------|-------------|
+| [Installation](docs/01-INSTALL.md) | Complete installation guide |
+| [Configuration](docs/02-CONFIGURATION.md) | Configuration options |
+| [API Reference](docs/03-API.md) | API endpoints and usage |
+| [Troubleshooting](docs/04-TROUBLESHOOTING.md) | Common issues and solutions |
+
+## Deployment Options
+
+### Local Development
+
+```bash
+npm run dev
+```
+
+### Production (PM2)
+
+```bash
+npm run daemon:start
+npm run daemon:status
+npm run daemon:logs
+```
+
+### Docker (if applicable)
+
+```bash
+docker build -t project-name .
+docker run -p 3000:3000 project-name
+```
+
+## Support
+
+For issues, check [Troubleshooting](docs/04-TROUBLESHOOTING.md) or open a GitHub issue.