@rutynka/helper-bar-board-sse
v0.1.5
Published
A simple Svelte app - sticky bar with SSE layer
Downloads
16
Maintainers
Readme
Bar Board with Server-Sent Events
A Svelte sticky bar board with Server-Sent Events for Rutynka apps.
Get started
Install the dependencies...
npx degit rutynka/helper-bar-board-sse
cd helper-bar-board-sse
yarn install
go run server.go
...then start Rollup:
yarn dev
Navigate to localhost:8080 or localhost:8080/iframe.html
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.
Import as Svelte Component
with bindings this
npx degit sveltejs/template my-svelte-project
cd my-svelte-project
node scripts/setupTypeScript.js
yarn install
yarn add @rutynka/helper-bar-board-sse
go run node_modules/@rutynka/helper-bar-board-sse/server.go
yarn dev
http://localhost:8080/
<script>
import {bbsse} from '@rutynka/helper-bar-board-sse'
export let name;
let bbsse;
function handleClick() {
let id = bb.init({settings:{text:'init 🌭 + 🌭 =',color:80,}})
bb.set({text:'🌭🌭',color:110,},id)
console.log('click')
}
</script>
<main>
<h1>Hello {name}!</h1>
<p>Visit the <a href="https://svelte.dev/tutorial">Svelte tutorial</a> to learn how to build Svelte apps.</p>
<button on:click={handleClick}>Show bar</button>
</main>
Building and running in production mode
To create an optimised version of the app:
npm run 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"
Using TypeScript
This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:
node scripts/setupTypeScript.js
Or remove the script via:
rm scripts/setupTypeScript.js
Deploying to the web
With Vercel
Install vercel
if you haven't already:
npm install -g vercel
Then, from within your project folder:
cd public
vercel deploy --name my-project