Zettel Terminal Extension Seed

This repository contains a seed project to speed-up developing extensions for Zettel Terminal. You can read more about the product here.

The repository insists of two projects:

1. The client project, this is the main extension implementation which is about to be executed along with the actual web-based app itself.

   Here are the scripts to support that:

   • To upgrade the Zettel dependencies @zettelproject/terminal-extension-api and @zettelproject/api-client to their newest versions:

     client$ npm run upgrade

   • To build the extension and pack the zip file to be uploaded to Zettel's Developer Console:

     client$ npm run build

     Note: The built extension goes to the client/output folder.

2. The server project, which is only needed for extensions which require their own server-side implementation.

   Here are the scripts to support that:

   • To upgrade the Zettel dependency @zettelproject/api-server to its newest version:

     server$ npm run upgrade

   • To start the server:

     server$ npm run dev   # For development, with hot reloads
     server$ npm start     # For production

Both projects are filled with some dummy implementations to show-case how to setup things, feel free to modify this as you like, or even start your own projects and follow the approaches in this seed project.

For more information, please contact the development team.