Skip to content

wmfs/tymly-base

Repository files navigation

Tymly-base

Tymly

Tymly build npm (scoped) Build Status Dependabot badge license


What?

This repo builds a runnable Docker image of Tymly from Tymly core and associated plugins.

It contains the following packages:


Build

The image is built with the Dockerfile

FROM node:9-alpine
LABEL maintainer="West Midlands Fire Service <tymly@wmfs.net>"
COPY . .
RUN npm install --production
CMD ["node", "./node_modules/@wmfs/tymly-runner/lib/index.js"]

Please see .dockerignore for repo contents excluded from the Docker image.

All that is copied from the repo into the image is:

  • config/
  • tools/
  • package.json

The run command

npm install --production

ensures that only production dependencies are installed in the image.


Versioning

Dependabot keeps dependencies up to date.

semantic-release handles the versioning of the image. See .releaserc.json for semantic-release configuration.

Please see the releases page or changelog for commit details.


Docker

This Docker image is free and available to pull from the Docker Hub.

docker pull wmfs/tymly-base

npm

Tymly-base is also published to npm as a package.


Config

Tymly requires configuration variables in order to boot.


Garnish

In order to add useful functionality to this base image you need to garnish this image with blueprints.

Please follow Dockerfile best practises when creating an image from Tymly-base.


Docs

More information on Tymly can be found on the website.


License

Tymly and it's components are licensed under the MIT License.