bbsfoki.blogg.se - Actions server plugin

#ACTIONS SERVER PLUGIN HOW TO#
#ACTIONS SERVER PLUGIN FULL#
#ACTIONS SERVER PLUGIN CODE#
#ACTIONS SERVER PLUGIN WINDOWS#

If you are publishing under an organisation, you may get an error message stating that payment is required. To publish your plug-in, run npm publish. To publish this to NPM, you should have an NPM account set up and be logged in from the command line with npm login - you only have to do this once and it will remember your login, even after you restart your computer. If you're using a graphical git client, perform the equivalent actions. If you are using the git command line, run git commit -am 'blank plugin' & git push. In the next part we will actually be defining our new datatype.Īs we have made a little bit of progress, setting up the plug-in directory structure, we should now commit with git and push to GitHub.

#ACTIONS SERVER PLUGIN HOW TO#

Commit and publishīecause this part of the tutorial is about the practical aspects, we will now see how to publish this (entirely useless) plugin. If everything works, then after a few seconds you should be directed back to the plug-in store with a success message: "Plugin saltcorn-angles-type installed". It does not matter whether you end in a slash or not

#ACTIONS SERVER PLUGIN FULL#

Location: enter the full path to the directory that contains your plug-in.

Name: the name of the plug-in as you specified it in the name field in the package.json file, here "saltcorn-angles-type".

You will then see a form that lets you enter the details of a plug-in. Choose the option "Add another plugin" (because we will be installing a plug-in that is not in the store) from this menu. Near the top right hand corner, there is a button with three dots that expand into a drop-down menu. Go to the "Plugins" menu option under "Settings". Also make sure you are logged in to an account with administrative privileges. Make sure you are running Saltcorn locally on your desktop, either a development environment based on SQLite or with a PostgreSQL server running in the background. Let's load this into a locally running Saltcorn instance so we can check that the plug-in load correctly. The package.json should look something like this: Typically, the JavaScript file is either called index.js or it is the name of the plug-in followed by. We will call this JavaScript file index.js but you can give it a different name as long as you put the chosen filename in the main field in the package.json.

#ACTIONS SERVER PLUGIN CODE#

You need to create at least two files in your new package: the package.json which describes the contents of the NPM package, and a JavaScript file containing the code for the plug-in. If you enter this directory ( cd angles-type) and list the files ( ls) there should now only be a single file present: the LICENCE file. For the example repository name, to clone this repository in my home directory I run on the command line: git clone :saltcorn/angles-type.git. Clone this repository into your home directory. If you are contributing this to the Saltcorn store, you will also need to choose a licence. gitignore file based on the Node template. Create a GitHub repositoryĬreate a GitHub repository on the your account. Note that you do not have to use GitHub or for that matter any kind of version control, you can use any other method you are familiar with for creating an NPM package. The finished example is available as the saltcorn/angles-type repository on GitHub. We will use a minimal example based on adding a new datatype for angular degrees. This page will describe the practical steps required to create a plug-in from a GitHub repository and published as an NPM package.

#ACTIONS SERVER PLUGIN WINDOWS#

Development of Saltcorn using Windows Subsystem for Linux (WSL) and Visual Studio Code.Getting started with plugin development.Authentication with external identity providers.Security and access control with user roles.Application administration and settings.Sending emails with blocks or JavaScript.Interfaces for many-to-many relationships.

Understanding fieldviews and view templates.Packs – shortcuts to working applications.