# cam-baker

> Non official Camunda CLI for building Tasklist embedded forms

Latest version **0.9.0** (published 2024-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install cam-baker
pnpm add cam-baker
yarn add cam-baker
bun add cam-baker
```

Provides the command `baker`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.0 |
| Published | 2024-05-12 |
| First published | 2022-07-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=20 |
| Dependencies | 23 |
| Unpacked size | 145.7 KB |
| Known vulnerabilities | 0 (+4 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Pedro Bernardo |
| Maintainers | pedbernardo |
| Keywords | camunda, forms, cli, build, tasklist |

## Links

- npm: https://www.npmjs.com/package/cam-baker
- Repository: https://github.com/pedbernardo/cam-baker
- Homepage: https://cam-baker.netlify.app
- Issues: https://github.com/pedbernardo/cam-baker/issues
- npm.io page: https://npm.io/package/cam-baker

## Dependencies (23)

- [ora](https://npm.io/package/ora.md) ^8.0.1
- [glob](https://npm.io/package/glob.md) ^10.3.15
- [sass](https://npm.io/package/sass.md) ^1.77.1
- [axios](https://npm.io/package/axios.md) ^1.6.8
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [esbuild](https://npm.io/package/esbuild.md) ^0.21.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [chokidar](https://npm.io/package/chokidar.md) ^3.6.0
- [htmlnano](https://npm.io/package/htmlnano.md) ^2.1.1
- [posthtml](https://npm.io/package/posthtml.md) ^0.16.6
- [commander](https://npm.io/package/commander.md) ^12.0.0
- [form-data](https://npm.io/package/form-data.md) ^4.0.0
- [livereload](https://npm.io/package/livereload.md) ^0.9.3
- [dotenv-flow](https://npm.io/package/dotenv-flow.md) ^4.1.0
- [json-server](https://npm.io/package/json-server.md) ^0.17.4
- [live-server](https://npm.io/package/live-server.md) ^1.2.2
- [run-camunda](https://npm.io/package/run-camunda.md) 8.0.0
- [fast-xml-parser](https://npm.io/package/fast-xml-parser.md) ^4.3.6
- [posthtml-include](https://npm.io/package/posthtml-include.md) ^2.0.1
- [posthtml-insert-at](https://npm.io/package/posthtml-insert-at.md) ^0.2.7
- [posthtml-expressions](https://npm.io/package/posthtml-expressions.md) ^1.11.3

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.9.0 (latest) — 2024-05-12
- 0.8.4 — 2024-05-12
- 0.8.3 — 2023-09-01
- 0.8.2 — 2023-07-10
- 0.8.1 — 2023-07-05
- 0.8.0 — 2023-07-04
- 0.7.1 — 2023-06-05
- 0.7.0 — 2023-06-05
- 0.6.0 — 2023-02-27
- 0.5.0 — 2023-02-20
- 0.4.2 — 2022-11-30
- 0.4.1 — 2022-11-30
- 0.4.0 — 2022-08-05
- 0.3.1 — 2022-08-04
- 0.3.0 — 2022-08-03
- … 4 more at https://npm.io/package/cam-baker/versions

## README

<h1 align="center">
  <br>
  <img
    src="./img/badge.png#gh-light-mode-only"
    alt="Camunda Baker Badge - Glowing smiley bread"
  >
  <img
    src="./img/badge-dark.png#gh-dark-mode-only"
    alt="Camunda Baker Badge - Glowing smiley bread"
  >
  <p>Camunda Baker</p>

  [![NPM](https://img.shields.io/npm/v/cam-baker)](https://www.npmjs.com/package/cam-baker)
  [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
  [![Netlify Status](https://api.netlify.com/api/v1/badges/6dd8f1fb-ff8b-4cb2-b332-ee82cade2d0c/deploy-status)](https://app.netlify.com/sites/cam-baker/deploys)
</h1>

<p align="center">
  Build complex projects using Camunda Tasklist, a <a href="https://camunda.com" target="_blank">Camunda</a> <em>non-official</em> frontend CLI<br>dedicated for building <strong>embedded forms</strong> with a modern stack.
</p>

<p align="center">
  <a href="#Installation">Installation</a> |
  <a href="#How-to-use">How to use</a> |
  <a href="#Configuration">Configuration</a>
</p>

<br>

<p align="center">
Visit the <a href="https://cam-baker.netlify.app" target="_blank">Documentation</a> for detailed instructions!
</p>

<br>

## Installation

```bash
npm install cam-baker

# or yarn

yarn add cam-baker
```

<br>

## How to use
Call CLI commands directly using `npx <command>` pattern:

```bash
npx baker dev
# or
npx baker build
# or
npx baker stop
```

Or create your own NPM Scripts on **package.json** to initilize and build the project
```json
{
  "scripts": {
    "dev": "baker",
    "build": "baker build",
    "stop": "baker stop"
  }
}
```

### Avaliable Commands
|Command    |Example     |Description|
|-----------|------------|-----------|
|`<default>`|baker -c config/my-config.js|initialize CLI watchers and services|
|dev        |baker dev   |same as above `baker` default command|
|build      |baker build |build entry files into standalone html files for Camunda Tasklist|
|stop       |baker stop  |stops Camunda Run server|
|help       |baker help  |show CLI commands and options|

**Custom Config Path and Filename:** `-c` or `--config`<br>
Used to indicate custom filename and path to the config file, needed when you don't want to use the default `camunda.config.js`.

```bash
npx baker --config config/my-custom-config-file.js
```

<br>

## Configuration

See the [Configuration Guide](https://cam-baker.netlify.app/guide/general)

<br>

### Configuration File Example

**camunda.config.js**
```js
import { defineConfig } from 'cam-baker'

export default defineConfig({
  // using `defineConfig` enables support for editor intellisense
})
```

<br>

## Next Steps
- Validate the idea throwing the repo for Camunda and dev community
- Add more detailed usage instructions, specially on how to handle deploys with `./public` and `./dist` artifacts
- Add more detailed usage instructions when running Camunda from a Spring Project (no need for `./public`)
- Add a minimal test coverage
- Evaluate usage of Vite with custom plugins/configuration instead low level implementations

---
_Source: https://npm.io/package/cam-baker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
