Convert audio into different formats.
Table of contents
Code linting and formatting
In the project directory, you can run:
Runs all (unit) tests.
npm run lint
Lints all code using ESLint.
npm run lint:format
Lints all code using ESLint, and formats it using Prettier.
npm run sls:debug
A Serverless dashboard has been setup for:
- Alerts (errors)
- RED metrics
- Basic observability based on:
- Date & time
- Function name
- Execution duration
- Memory usage
- Cold start time
CircleCI is used to:
- Audit npm dependencies for security vulnerabilities.
- Run unit/integration tests (Jest).
- Deploy services via Serverless Framework.
CircleCI requires a "Serverless Personal Access Key" to deploy services. This is configured as an environment variable named
SERVERLESS_ACCESS_KEY in the CircleCI credentials context.
The value of the access key can be found in the 1Password "Upstand FM" vault under "Serverless access key for CircleCI".
The access key allows the Serverless CLI (used by CircleCI in the
release job) to authenticate with the Serverless Framework Dashboard.
Additionally, an access role has been configured to help secure resource deployments on AWS, by enabling the Serverless Framework to issue temporary AWS access keys to deploy resources. These keys are generated by Serverless Framework on every command, and the credentials expire after one hour.
The Serverless Framework leverages AWS Security Token Service and the AssumeRole API to automate creating and usage of temporary credentials, so your developers can stay productive and work securely without doing this manually.
We also use a separate CloudFormation role to limit access during deployment, to only the required set of permissions needed by Serverless to deploy resources (i.e. no
AdministratorAccess). This is done by setting
provider.cfnRole in the Serverless manifest.