Origami Frontend Components & Services

Readme: origami-service-makefile

Common tools for building and running Origami services.

NPM version
Build status
MIT licensed

Table Of Contents

Usage

Origami Service Makefile provides a set of common tools that are required for building and running Origami services. To use the Makefile, copy the boilerplate.mk file to the root of your repo and name it Makefile:

curl https://raw.githubusercontent.com/Financial-Times/origami-service-makefile/master/boilerplate.mk > Makefile

Now install this module and save it to your package.json file:

npm install --save @financial-times/origami-service-makefile

You should now be able to run the following commands:

make install       # Install application dependencies
make verify        # Verify code using static analysis
make test          # Run unit and integration tests
make run           # Run the application as if in production
make run-dev       # Run the application and restart when files change
make deploy        # Deploy the application to QA
make release       # Run required tasks before a release goes live
make promote       # Promote a QA deploy to production
make auto-version  # Auto-version the repo and create a GitHub release
make cmdb-update   # Update CMDB endpoints for the application
make release-log   # Create a release log for the application in Salesforce
make grafana-pull  # Pull changes from the Grafana dashboard
make grafana-push  # Push changes to the Grafana dashboard

Configuration

The Origami Service Makefile can be configured with [environment variables] either in an extending Makefiles or externally. Some configurations are required to never be committed for security reasons, these have been separated below.

Safe Configurations

These configurations are safe to include in your extending Makefile, and should be kept there to avoid repetition of their values:

Private Configurations

These configurations must never appear in your source code, and so should be set in CI, or Heroku, or an .env file locally:

Contact

If you have any questions or comments about this module, or need help using it, please either raise an issue, visit #ft-origami or email Origami Support.

Licence

This software is published by the Financial Times under the MIT licence.

Switch component view

GitHub Repository