alexeden / node-remote-repo-template

All of the boilerplate I usually need for writing a Node+Typescript library run on a remote device (Raspberry Pi)

Node Remote Repo Template

Clone the repo

Since this is a template, you'll wanna add some flags to your clone command so that you can get the repo without all of its commit history and emotional baggage:

$ git clone --depth=1 https://github.com/alexeden/node-remote-repo-template.git <your new repo's name>
$ rm -rf !$/.git

Workflow

Make sure you have passwordless SSH access to your Raspberry Pi.

Clone/fork your repo onto both your local machine and your Raspberry Pi.

npm install inside the project on both your local machine and the remote device.

Create a file called sync.config.json on the machine on which you'll be developing, and substitute these values with your own:

{
  "username": "<<<username>>>",
  "hostname": "<<<hostname or IP address of your remote device>>>",
  "directory": "<<<parent directory on remote device into which the repo was cloned>>>",
  "quiet": false // Disable most rsync logs (defaults to false)
}

Locally, you can now run npm run sync-changes, and any changes made to files inside /src or /examples will automatically be uploaded to your Pi.

You can configure which excluded from uploaded by opening sync.js and modifying the exclude option passed to Rsync.build.

From the remote device, you can run npm run build-changes, and any changes pushed from your local machine will automatically be rebuilt. You can run additional scripts (test scripts, etc) by appending the shell commands to the exec property inside nodemon.build.json.