Skip to content
This repository has been archived by the owner on Oct 4, 2022. It is now read-only.

Latest commit

 

History

History
90 lines (56 loc) · 2.57 KB

README.md

File metadata and controls

90 lines (56 loc) · 2.57 KB
Raw

Coverage Status

Dalmatian Frontend

This service is intended to be used by developers and designers who need to view and change the way applications are hosted on Dalmatian.

Due to risks associated with the high level of access, this service is designed to be run locally instead of being hosted on the internet. It will use your machines AWS configuration.

Prerequisites

This application depends on Dalmatian tools being installed and used to login into AWS via dalmatian login.

Getting started

Run the setup script:

script/setup

Run the tests:

script/test

Start the server:

script/server

Start a console:

script/console

Static code analysis

Run Brakeman to highlight any security vulnerabilities:

brakeman

To pipe the results to a file:

brakeman -o report.text

Making changes

When making a change, update the changelog using the Keep a Changelog 1.0.0 format. Pull requests should not be merged before any relevant updates are made.

Releasing changes

When making a new release, update the changelog in the release pull request.

Architecture decision records

We use ADRs to document architectural decisions that we make. They can be found in doc/architecture/decisions and contributed to with the adr-tools.

Managing environment variables

We use Dotenv to manage our environment variables locally.

The repository will include safe defaults for development in /.env.example and for test in /.env.test. We use 'example' instead of 'development' (from the Dotenv docs) to be consistent with current dxw conventions and to make it more explicit that these values are not to be committed.

To manage sensitive environment variables:

  1. Add the new key and safe default value to the /.env.example file eg. ROLLBAR_TOKEN=ROLLBAR_TOKEN
  2. Add the new key and real value to your local /.env.development.local file, which should never be checked into Git. This file will look something like ROLLBAR_TOKEN=123456789

Access

TODO: Where can people find the service and the different environments?

Source

This repository was bootstrapped from dxw's rails-template.