0.13.3 • Published 8 months ago

@mochabug/adaptkit v0.13.3

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
8 months ago

@mochabug/adaptkit : The Magical CLI for Mochabug Adapt Plugin Development!

Welcome to @mochabug/adaptkit! Prepare to embark on a whimsical adventure filled with creativity and efficiency! @mochabug/adaptkit is a powerful CLI tool designed to help you effortlessly develop and manage plugins for the Mochabug Adapt platform. With @mochabug/adaptkit, you can:

  • 🌈 Create enchanting template projects for plugin development
  • 🧙‍♂️ Emulate your plugins in a cloud environment with just a flick of your wand
  • 🧚 Add and modify vertices to your plugin project with ease
  • 🌟 Automagically handle tedious tasks that often bog down software development

Magical Vertices: Your Plugin Building Blocks 🔮

Vertices, also known as tasks, are the building blocks of your plugins. Each plugin consists of one or more vertices. A vertex in @mochabug/adaptkit consists of two parts: an Executor and an optional Configurator.

  • Executor: A mandatory part that performs tasks. It can have different types:

    • Action: Performs tasks without interacting with external systems
    • Cron Trigger: Triggers actions at specified intervals, like clockwork
    • External Trigger: Activates tasks from an external endpoint, bringing the magic to the outside world
    • Browser: Runs tasks within a browser, where requests end up on the external endpoint
  • Configurator: An optional part that customizes the behavior of the executor. Configurators interact with users on the Mochabug Adapt platform, making them "external" by nature.

Getting Started 🚀

To start your magical journey with @mochabug/adaptkit, install the package using the following incantation:

npm install -g @mochabug/adaptkit

Usage 🪄

With @mochabug/adaptkit installed, you can now wield your newfound powers to develop and manage your plugin projects! Here's a guide to help you harness the magic:

  1. Create a template project for plugin development
adaptkit --init

This command generates a manifest.json file, Executor and Configurator templates, and .cue schema files with information about your plugin.

  1. Emulate your plugins in the cloud environment
adaptkit --emulate

Test your plugin's sorcery in a controlled environment by emulating its behavior in the cloud.

In order to do this you need to have docker installed and run the emulator locally using the following command:

docker run --rm -it -p 51001:51001 -p 51002:51002 -p 51003:51003 -p 51004:51004 -p 51005:51005 mochabug/adaptsandbox:latest

Note: The 5 ports is required to simulate the different vertex types as well as the graphical interface together with the publish endpoint of adaptkit.

  1. Add and modify vertices
adaptkit --add-vertex [vertexType] [vertexName]

Easily add or modify vertices to your plugin project by specifying the vertex type and name.

  1. Publish your plugin to the Mochabug Adapt platform
adaptkit --publish

Share your magical creation with the world by publishing your plugin to the Mochabug Adapt platform.

Documentation 📚

For a more comprehensive spellbook on how to use @mochabug/adaptkit and unlock the full potential of our captivating plugin system for Mochabug Adapt, visit our documentation.

Contribute 🤝

@mochabug/adaptkit s is a community-driven, open-source project, and we warmly welcome your contributions! If you have an idea for a new type, a bug report, or would like to help with documentation, please open an issue or submit a pull request.

A Magical Journey Awaits! 🍄

0.13.3

8 months ago

0.13.1

8 months ago

0.13.0

8 months ago

0.12.20

8 months ago

0.12.19

9 months ago

0.12.16

9 months ago

0.12.17

9 months ago

0.12.18

9 months ago

0.12.15

9 months ago

0.12.10

9 months ago

0.12.11

9 months ago

0.12.7

9 months ago

0.12.8

9 months ago

0.12.12

9 months ago

0.12.13

9 months ago

0.12.14

9 months ago

0.12.5

9 months ago

0.12.6

9 months ago

0.12.4

9 months ago

0.12.3

9 months ago

0.12.2

10 months ago

0.12.1

10 months ago

0.12.0

10 months ago

0.9.12

12 months ago

0.9.14

11 months ago

0.9.15

11 months ago

0.9.10

1 year ago

0.9.11

1 year ago

0.11.0

10 months ago

0.11.1

10 months ago

0.11.2

10 months ago

0.11.3

10 months ago

0.11.4

10 months ago

0.9.8

1 year ago

0.9.9

1 year ago

0.10.1

11 months ago

0.10.2

11 months ago

0.10.3

11 months ago

0.10.0

11 months ago

0.9.7

1 year ago

0.9.6

1 year ago

0.9.4

1 year ago

0.9.3

1 year ago

0.9.2

1 year ago

0.9.1

1 year ago

0.9.0

1 year ago

0.8.10

1 year ago

0.8.9

2 years ago

0.8.5

2 years ago

0.8.7

2 years ago

0.8.6

2 years ago

0.8.4

2 years ago

0.8.3

2 years ago

0.8.1

2 years ago

0.8.2

2 years ago

0.4.0-alpha.1

2 years ago

0.1.0-alpha.30

2 years ago

0.4.1-alpha.1

2 years ago

0.1.0-alpha.32

2 years ago

0.1.0-alpha.31

2 years ago

0.1.0-alpha.12

2 years ago

0.1.0-alpha.33

2 years ago

0.1.0-alpha.11

2 years ago

0.1.0-alpha.36

2 years ago

0.1.0-alpha.35

2 years ago

0.1.0-alpha.13

2 years ago

0.1.0-alpha.16

2 years ago

0.1.0-alpha.37

2 years ago

0.1.0-alpha.15

2 years ago

0.1.0-alpha.18

2 years ago

0.1.0-alpha.17

2 years ago

0.1.0-alpha.19

2 years ago

0.2.0-alpha.2

2 years ago

0.2.0-alpha.1

2 years ago

0.5.0-alpha.2

2 years ago

0.5.0-alpha.1

2 years ago

0.1.0-alpha.21

2 years ago

0.1.0-alpha.20

2 years ago

0.1.0-alpha.23

2 years ago

0.1.0-alpha.24

2 years ago

0.1.0-alpha.27

2 years ago

0.1.0-alpha.26

2 years ago

0.7.0-alpha.1

2 years ago

0.1.0-alpha.29

2 years ago

0.1.0-alpha.28

2 years ago

0.7.0-alpha.3

2 years ago

0.7.0-alpha.2

2 years ago

0.7.0-alpha.4

2 years ago

0.8.0

2 years ago

0.3.0-alpha.1

2 years ago

0.1.0-alpha.10

2 years ago

0.1.0-alpha.9

2 years ago

0.1.0-alpha.8

2 years ago

0.1.0-alpha.5

2 years ago

0.1.0-alpha.4

2 years ago

0.1.0-alpha.3

2 years ago

0.1.0-alpha.1

2 years ago