Jeffrey Carpenter cad6fb61b6 Merge `dev` branch upstream (master) 1 year ago
bin Re-add use of `.npmrc` configuration values 1 year ago
docs Update npm run scripts for webpack 2 years ago
src main.scss: Add missing Montserrat:300 (who-we-are) 1 year ago
tasks Update CDN API tasks and dependencies 1 year ago
tests Introduce regression testing through gemini 1 year ago
.babelrc Edit .babelrc to work with rollup. 2 years ago
.doiuse.json postcss.config.js: Move doiuse & colorguard to dedicated npm tasks 1 year ago
.editorconfig initial commit 2 years ago
.env.defaults Update CDN API tasks and dependencies 1 year ago
.gemini.js Introduce regression testing through gemini 1 year ago
.gitattributes Add .gitattributes from web-starter-kit.git 2 years ago
.gitignore Update CDN API tasks and dependencies 1 year ago
.htmlhintrc initial commit 2 years ago
.sass-lint.yml Add config file for sass-lint 2 years ago
.stylelintrc Introduce basic stylelint configuration extending their recommended 1 year ago
.tern-project Add basic .tern-project file for ternjs 2 years ago
.travis.yml initial commit 2 years ago
LICENSE.md Add LICENSE.md stub file 2 years ago
README.md Re-add use of `.npmrc` configuration values 1 year ago
dev-server.js dev-server.js: Add check for .npmrc env vars 1 year ago
imbue.studio.sublime-project imbue.studio.sublime-project: More ignore filters 1 year ago
package.json Revert "Update packages" 1 year ago
postcss.config.js postcss.config.js: Move doiuse & colorguard to dedicated npm tasks 1 year ago
shipitfile.js shipitfile.js: Add deploy:cdn task 1 year ago
webpack.config.js Merge branch 'dev' in to master 1 year ago
yarn.lock Update yarn.lock 1 year ago

README.md

Imbue Boilerplate

Usage

git clone ssh://git.imbue.studio:8484/imbue-boilerplate.git
cd imbue-boilerplate.git

npm install

# npm run serve

Generating Documentation

npm install jsdoc
NODE_ENV=development npm run build:docs

Development Environment

npm run build:dev

Production Environment

npm run build:prod

Configuration

IMPORTANT: When both .npmrc and .env configuration files exist, the .npmrc values will be favored.

.npmrc .env shell

Deploy

Set development mode ON at imbue.studio on Cloudflare:

npm run cache:dev

or:

npm run cache:dev_on

Set development mode OFF at imbue.studio on Cloudflare:

npm run cache:dev_off

Purge our CDN cache at imbue.studio on Cloudflare:

npm run cache:purge

The cache npm tasks requires a local npm config environment with the right credentials setup for your Cloudflare account.

Create a file named .npmrc at this project's root directory with the following contents:

CLOUDFLARE_AUTH_EMAIL=<cloudflare_email_address>
CLOUDFLARE_AUTH_KEY=<cloudflare_api_token_key>
CLOUDFLARE_WEBSITE_NAME=<cloudflare_site_name>

The environment variable CLOUDFLARE_WEBSITE_NAME is the same as the resulting zone ID record that you want upon calling Cloudflare's list-zones API [1].

Deploy to the host where the production web site resides:

npm run deploy

1. https://api.cloudflare.com/#zone-list-zones

Project Origins

This boilerplate derived from the following list:

Scratch

...