Getting started

This section gets a new developer from checkout to a running service and a validated docs build.

Prerequisites

Requirement	Notes
Node and Yarn	Use Volta; the repo pins versions. Use `yarn`, not npm, for repo commands.
Docker	Required for local DynamoDB and ElasticMQ/SQS in `docker-compose.yml`.
AWS profiles	`aws-drive-staging-admin` for dev/staging; `aws-drive-prod-admin` for prod-only operations.
`SERVERLESS_ACCESS_KEY`	Required by Serverless Framework v4 commands.
`GH_REGISTRY_TOKEN`	GitHub token with `read:packages` for private package install.
`BUILD_PLATFORM`	Set when your build platform differs from `linux/arm64`.

Repository layout

drive-apig/
  serverless.common.yml       shared provider config
  collector.yaml              OTel collector config bundled into Lambdas
  docker-compose.yml          local DynamoDB and SQS
  bin/                        repo scripts, including env generation
  libs/                       shared TypeScript libraries
  services/                   deployable Serverless services
  platform/terraform/         shared AWS infra and docs hosting
  docs/site/                  standalone docs site package
  outputs/                    generated stack output JSON
  package.json                root workspace scripts

First useful checks

bash

yarn install
yarn typecheck
yarn test

For docs-only work:

bash

cd docs/site
yarn dev
yarn build

Pages

Topic	Page
Clone, install, run a service offline	Local setup
dev / staging / prod accounts, stages	Environments
Branching, PR template, deploy flow	Contributing