0.8.3 • Published 8 months ago

cam-baker v0.8.3

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

NPM License Netlify Status

Installation

npm install cam-baker

# or yarn

yarn add cam-baker

How to use

Call CLI commands directly using npx <command> pattern:

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

{
  "scripts": {
    "dev": "baker",
    "build": "baker build",
    "stop": "baker stop"
  }
}

Avaliable Commands

CommandExampleDescription
<default>baker -c config/my-config.jsinitialize CLI watchers and services
devbaker devsame as above baker default command
buildbaker buildbuild entry files into standalone html files for Camunda Tasklist
stopbaker stopstops Camunda Run server
helpbaker helpshow CLI commands and options

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

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

Configuration

See the Configuration Guide

Configuration File Example

camunda.config.js

import { defineConfig } from 'cam-baker'

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

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