Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 1.87 KB

README.md

File metadata and controls

47 lines (28 loc) · 1.87 KB

Plugin: Webinterface

This is the official cliff webinterface plugin

Note that you will need to have Node.js installed. This is currently just a svelte workspace. It is planned to switch the whole workspace to Deno using the WIP cliff plugin API.

Get started

Install the dependencies...

yarn install

...then start Rollup:

yarn dev

Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

If you're using Visual Studio Code we recommend installing the official extension Svelte for VS Code. If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.

Building and running in production mode

To create an optimised version of the app:

yarn build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Single-page app mode

By default, sirv will only respond to requests that match files in public. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.

If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for any path. You can make it so by editing the "start" command in package.json:

"start": "sirv public --single"