1. Create a .env file

cp .env.template .env

Update values as needed (see Environment Variables.

2. Install Node.js version 18 (doing this using nvm is recommended).

3. Install dependencies

npm install
npm install -ws

4. psql needs to be installed for running tests

Depending on the work being done, some environment variable will not be required for the service to run. For these, simply fill in any fake value to prevent require-env-variable from throwing errors.

Run

npm run lint -ws

Make sure the local database from devenv's docker compose is running

docker compose up -d

then run tests with

npm run test -ws

or, for a single project, specify the workspace

npm run test -w @stela/api

Note that the database tests run against is dropped and recreated at the beginning of each test run.

For running tests on a single file in stela, you can make an adjustment to the existing test command in packages/api/package.json on your machine. See the example below (replace src/middleware/authentication.test.ts with a pattern to match your file):

    "test:file": "npm run start-containers && npm run clear-database && npm run create-database && npm run set-up-database && (cd ../..; docker compose run stela node --experimental-vm-modules ../../node_modules/jest/bin/jest.js -i --silent=false -- src/middleware/authentication.test.ts)",

Preferred method: From the devenv repo, run

docker compose up -d

or if you've added or updated dependencies, run

docker compose up -d --build stela

Outside a container: Run

npm run start -w @stela/api

1. Build the lambda image

docker build --platform linux/amd64 -t <LAMBDA NAME>:test -f Dockerfile.<LAMBDA NAME> .

2. Run the lambda container. Add additional --env arguments as needed. Note that the CLOUDFRONT_PRIVATE_KEY required by the record_thumbnail_attacher must include literal newlines; docker does not appear to interpret \n correctly.

docker run --platform linux/amd64 -p 9001:8080 --env DATABASE_URL=postgres:https://postgres:permanent@database:5432/permanent <LAMBDA NAME>:test

3. Find the container name

docker ps

4. Connect to the local env docker network

docker network connect devenv_default <YOUR CONTAINER NAME>

5. Trigger the lambda

curl "https://localhost:9001/2015-03-31/functions/function/invocations" -d '<YOUR PAYLOAD>'

stela deploys to dev automatically upon any merge to main.

To deploy to staging and prod, create a Release with a tag of the form vX.X.X (this should conform to semantic versioning). This will trigger a deploy to staging. If that is successful, the workflow will pause and wait for manual approval to deploy to prod. Given manual approval, it will deploy to prod.

To deploy to staging without deploying to prod, run the "Deploy to staging" workflow from the Actions tab.

Because dev and staging run on the same EKS cluster, deploys to each of these environments just target the stela deployments and won't update the underlying infrastructure they run on. To update that infrastructure, manually trigger the "Deploy to all test envs" workflow from the Actions tab in Github. This will deploy the current main branch to dev and staging in addition to updating the test cluster infrastructure.