squirrel-development-server

squirrel update server for local development and testing

Usage no npm install needed!

<script type="module">
  import squirrelDevelopmentServer from 'https://cdn.skypack.dev/squirrel-development-server';
</script>

README

squirrel-development-server

Simple localhosted squirrel update server. goal: api-compatible with nuts.

Folder structure

releases/
    0.0.1/
        app-win32-full.nupkg
        app-darwin.zip
    0.0.2/
        app-win32-full.nupkg
        app-darwin.zip
    .
    .
    .

CLI Usage

$ npm install -g squirrel-development-server
$ squirrel-development-server [directory]

options

  • directory: directory where version folders are located, defaults to CWD
  • -p, --port: port to listen to

Express middleware

$ npm install --save squirrel-development-server

var squirrel = require('squirrel-development-server/middleware')
var express  = require('express')
var app      = express()

app
    .use(squirrel({
        log: true, // enable request logging
        releasesPath: __dirname + '/releases', // directory where version folders are located
        address: 'http://localhost:6363' // the address to reach this server. used as prefix to URLs
    }))
    .listen(6363)

Roadmap

  • Darwin minimal update server
  • Automatic address detection
  • Windows minimal update server
  • Nuts version API

Compatibility

  • node: v4.0.0 or later

only tested on macOS

Tests

not available yet, PR welcome

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. Contact-me personally instead.

Author

Leonardo Dino

License

This project is licensed under the MIT license. See the LICENSE file for more info.