isabella232 / doncab-framework Goto Github PK

Doncab Framework

A portfolio framework with unique Project gallery layouts

NOTICE: This code is licensed to you pursuant to Squarespace’s Developer Terms of Use. See license section below.

Features

• Full Width, Half Width, Alternating Width and Grid layout options for Index Collections
• Several gallery layout options for Project Collections to display your portfolio work
• Page transition animations
• AJAX loaded pages

Basic Usage

This template uses Node Package Manager to handle dependency management and run build scripts. After cloning this repo, install dependencies:

npm install

To use the local development process, you'll need to install the Squarespace Local Development Server separately, then run:

npm start

To deploy to your live Squarespace site, run:

npm run deploy

NPM Script Reference

This template's NPM scripts make extensive use of squarespace CLI commands. To learn more about what's happening under the hood, check out Squarespace Toolbelt on Github.

npm run build

Cleans the build folder, copies Squarespace files (JSON-T, LESS, assets) into the build folder from source and node_modules, and runs Webpack to bundle Javascript.

npm run clean

Cleans the build folder, removing all build results.

npm run deploy

Deploys your built template to production using Git. If not already configured, initializes a Git repo for deployment in your build folder. Note this is separate from your source repository, and will only contain the build result.

npm run lint

Runs ESLint on the scripts in your /scripts folder.

npm start

Runs watch, and simultaneously launches Squarespace Server. By default this runs on localhost:9000.

npm run server

Launches Squarespace Server.

npm run server:auth

Launches Squarespace Server, prompting you for your Squarespace authentication details. Useful if your site is password-protected.

npm run watch

Watches your source directory as well as your scripts and modules for changes, and builds on the fly when changes are detected.

License

Portions Copyright © 2016 Squarespace, Inc. This code is licensed to you pursuant to Squarespace’s Developer Terms of Use, available at http://developers.squarespace.com/developer-terms-of-use (the “Developer Terms”). You may only use this code on websites hosted by Squarespace, and in compliance with the Developer Terms. TO THE FULLEST EXTENT PERMITTED BY LAW, SQUARESPACE PROVIDES ITS CODE TO YOU ON AN “AS IS” BASIS WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED.