0.0.8 • Published 9 months ago

@silexlabs/silex-puter v0.0.8

Weekly downloads
-
License
MIT
Repository
-
Last release
9 months ago

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:

  • Open / save website to / from puter file system
  • 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

OptionDescriptionDefault
option1Description optiondefault 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

0.0.8

9 months ago

0.0.7

9 months ago

0.0.6

9 months ago

0.0.5

9 months ago