Silex Puter Plugin

A good place to start writing a Silex plugin. It supports server and/or client side plugins, in Javascript and TypeScript. Check Silex developer docs if you need help or join the discussions in the forum

Start creating your plugin from src/main.js or src/main.ts, read the Development section

Features / TODO:

• [x] Open / save website to / from puter file system
• [x] Publish website to puter hosting
• [ ] Upload assets to puter
• [ ] Test and debug
• [ ] Docs
• [ ] Write tests

Installation

This is how to use the silex-puter plugin in your Silex instance or JS project

Add as a dependency

$ npm i --save @silexlabs/silex-puter

Add to Silex config (client or server)

import plugin from '@silexlabs/silex-puter'
// Or import YourPlugin from '../path/to/silex-puter'
// Or import YourPlugin from 'http://unpkg.com/your-plugin'
export default function(config, options) {
  config.addPlugin(plugin, {
    // ... plugin config ...
  })
};

Options

|Option|Description|Default| |-|-|- |option1|Description option|default value|

Development

Clone the repository

$ git clone https://github.com/silexlabs/silex-puter.git
$ cd silex-puter

Install dependencies

$ npm i

Build and watch for changes

$ npm run build:watch

Start the dev server on port 3000 with watch and debug

$ npm run dev

Publish a new version

$ npm test
$ npm run lint:fix
$ git commit -am "new feature"
$ npm version patch
$ git push origin main --follow-tags

License

MIT