@daouy/n8n-nodes-carbone/README.md

n8n nodes for Carbone integration

# n8n-nodes-carbone

Đây là một gói node tùy chỉnh cho n8n để tích hợp với Carbone API.

## Tổng quan

Gói này cung cấp các node để tương tác với Carbone API theo thiết kế lifecycle, cho phép bạn:

1. Tạo và quản lý template
2. Tạo báo cáo từ template và dữ liệu
3. Kiểm tra trạng thái báo cáo
4. Tải xuống báo cáo đã tạo

## Cài đặt

### Cài đặt cục bộ

1. Đi đến thư mục n8n của bạn
   ```
   cd ~/.n8n
   ```

2. Cài đặt gói node
   ```
   npm install n8n-nodes-carbone
   ```

3. Khởi động lại n8n

### Cài đặt trong Docker

Thêm dòng sau vào Dockerfile của bạn:
```dockerfile
RUN cd /usr/local/lib/node_modules/n8n && npm install n8n-nodes-carbone
```

## Sử dụng

Sau khi cài đặt, bạn sẽ thấy node "Carbone Lifecycle" trong danh sách node của n8n.

### Thiết lập Credentials

1. Tạo credential mới kiểu "Carbone API"
2. Nhập URL API của Carbone (ví dụ: https://your-carbone-domain.com/api)
3. Nhập API Key của bạn

### Các thao tác có sẵn

- **Create Template**: Tải lên và đăng ký template mới
- **Generate Report**: Tạo báo cáo từ template và dữ liệu
- **Get Report Status**: Kiểm tra trạng thái của quá trình tạo báo cáo
- **Download Report**: Tải xuống báo cáo đã tạo

## Phát triển

### Cài đặt môi trường phát triển

```bash
# Clone repository
git clone <repository-url>

# Cài đặt dependencies
npm install

# Build
npm run build

# Link để phát triển cục bộ
npm link
```

### Cấu trúc dự án

```
n8n-nodes-carbone/
├── credentials/
│   └── CarboneApi.credentials.ts
├── nodes/
│   └── Carbone/
│       ├── CarboneLifecycle.node.ts
│       └── carbone.svg
├── package.json
└── tsconfig.json
```

## Giấy phép

[MIT](LICENSE.md)


npm run build
npm pack --dry-run
npm publish