Boxen
A Kit of Parts Squarespace developer SDK.
Getting started
These are the stable versions of Squarespace packages the SDK uses. The toolbelt and core packages are included in the package.json dependencies. Those rely on a global install of the Squarespace server via npm.
Install the boxen command line interface:
# Boxen CLI
npm i boxen-sqs -g
# Global sqs server
npm i -g @squarespace/serverYou can initialize boxen in your current working directory, or pass a folder name you would like boxen to create and initialize within:
# Assuming you are in the directory you want to initialize from
boxen init
# Assuming you want boxen to create the directory for you to initialize from
boxen init my-projectDocumentation
That's it! Checkout the boxen docs for complete info on developing with the SDK.
Trouble shooting
Trouble shooting
The Squarespace server won't work anymore for older versions due to updates with the developer license agreement. If you get the following message: "This version of local developer is incompatible, please update to the latest version.", do just that and update.
You'll need to provide an authentication token for the server. Use the npm script npm run sqs:server:auth to prompt this message: "Please navigate to the following URL:"" followed by a complicated looking URL. Dump that URL in a browser and copy the token from the Command-line Authorization page. Paste that token into the sqs command-line. Ctrl+D and npm start.