upmk docs

Basics Commands install secrets deploy dev dyna build generate package pull push filters Templating Dynamic Pages Redirects JSON endpoints Auth Serving Files Editor Templates AddOns Plugins

AddOns

an upmk addon is a set of functionality that can be bolted on to an upmk project. it contains model definitions, model instances, controllers, views, styles, javascript, and assets

building an addon

the general flow of working with an addon is to generate an addon into an existing project where it can be developed. upmk will work within the addon in addition to it's typical lookups for files.

see the upmk g addon command

once the addon is to a state that it can be reused in other projects, you can try it out by installing it into another project (see installing an addon below). eventually you can pull the addon into it's own repo (literally just copy the addon folder out of app/add-ons/)

installing an addon

for details on installing an addon see the upmk install command

example

the jsk-slides repo is the first example of an addon. it was intially built into an upmkarkers project as an addon, once working and happy, it was pulled into a standalone addon for reuse.