@6river/strap-core

Bootstrap a developer machine.

Usage no npm install needed!

<script type="module">
  import 6riverStrapCore from 'https://cdn.skypack.dev/@6river/strap-core';
</script>

README

strap

codecov CircleCI

Bootstrap script for provisioning developer machines.

Development

To build and run the app in production:

To run an HTTPS proxy in front of the app:

To run tests once:

  • npm run test:single

To run tests and re-run on changes:

  • npm test

To lint:

  • npm run lint

To build:

  • npm run build

Usage

To run the web application locally run:

git clone https://github.com/6RiverSystems/strap-core
cd strap-core
npm install
# Setup config.json5
GITHUB_KEY="..." GITHUB_SECRET="..." npm start

Web Application Environment Variables

Required

  • GITHUB_KEY: GitHub application client ID
  • GITHUB_SECRET: GitHub application client secret
  • ARTIFACTORY_TOKEN: API key of an Artifactory administrator account
  • ARTIFACTORY_URL: base URL of the hosted Artifactory instance, i.e. https://foo.jfrog.io/foo/ (include trailing slash)

Optional

  • PORT: the port to run the application on, defaults to 5000
  • SESSION_SECRET: secret token to use for sessions, defaults to a randomly generated token
  • LOG_LEVEL: trace, debug, info, warn, fatal, or silent, defaults to info

Resources