Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 2.02 KB

README.md

File metadata and controls

88 lines (61 loc) · 2.02 KB

Silex Puter Plugin

The Silex Puter Plugin brings Silex’s professional website-building capabilities to the Puter environment, letting users create, save, and publish static websites directly in Puter. This plugin enables seamless integration, making it easier than ever to use Silex within Puter for web design and content management.

Here is the code of a Silex instance using this plugin and the instance is available on puter.silex.me

Check Silex developer docs if you need help on seting up Silex to use this plugin or join the discussions in the forum

🌐 Try Silex on Puter – Fully integrated and ready for your next website project!

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

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