Coder Social home page Coder Social logo

pedbernardo / cam-baker Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 0.0 937 KB

Camunda non-official frontend CLI dedicated for building embedded forms

Home Page: https://cam-baker.netlify.app

License: MIT License

JavaScript 99.74% Shell 0.26%
camunda cli frontend tasklist

cam-baker's Introduction


Camunda Baker Badge - Glowing smiley bread Camunda Baker Badge - Glowing smiley bread

Camunda Baker

NPM License Netlify Status

Build complex projects using Camunda Tasklist, a Camunda non-official frontend CLI
dedicated for building embedded forms with a modern stack.

Installation | How to use | Configuration


Visit the Documentation for detailed instructions!


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

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
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

cam-baker's People

Contributors

pedbernardo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.