Skip to content

cul/cul-toolkit

Repository files navigation

CUL Toolkit

Development requirements

nodejs >= v10.17.0
yarn >= 1.19.1

Run Webpack Server for development

Server runs on http://localhost:3000 and auto-recompiles code when resources change.

yarn start

Deployment requirements

Local machine:

ruby >= 2.5.3 (we currently have a .ruby-version file requiring 2.5.3)
bundler

Remote deployment server:

node >= 10.17.0
yarn >= 1.19.1

Deploying a versioned release

Update the version in your package.json file.

Run bundle install the first time you want to deploy, or if the Gemfile/Gemfile.lock has changed:

bundle install

Use capistrano to deploy to the desired environment (dev/test/prod):

Dev deployment example:

cap dev deploy # or replace "dev" with "test" or "prod"

Note: In order to deploy, you need to have your public key in the remote server user's authorized_keys file on your dev/test/prod hosts.

Standalone Build Instructions

yarn install # run the first time you want to build, or if the package.json/yarn.lock file has changed
yarn build