Holi App Events

The backend for handling event aggregation, including a GraphQL API for JASD.

• Holi App Events
  • Getting started
    • Setup
    • Code style
    • Dependencies
    • Compiling (optional)
    • Testing
    • Tasks
    • VS Code extension
  • Local execution
  • Continuous Integration and Deployment
    • Skipping parts of CI
      • noenv Branches
  • Runtime / Deployment
    • Configuration

Getting started

Setup

Install deno in version 2.2

Code style

Linting:

deno task lint

Formatting:

deno task fmt

Configuration for typescript, linter or formatter can be added in deno.json.

See the deno manual for more tools.

Dependencies

All dependencies should be added in app/deps.ts (similiar as you would do in a Node.js package.json) for caching and integrity checks. After adding a dependency run:

deno task updateDeps

to update the deno.lock file (similiar to Node.js package.lock including hashes).

To just install and cache dependencies locally or force a reload of dependencies, run:

deno task install

Compiling (optional)

Deno will compile all TypeScript code to JavaScript and cache the resulting files. This will happen automatically when you run the code, but you can also trigger this manually by running

deno task cache

Testing

Unit tests

can be executed with

deno task test

Smoke test

Install k6 first

can be locally executed against a started service with

deno task smoketest

Tasks

We use deno tasks to execute scripts that are defined beneath taskss in deno.json (similiar to scripts defined in Node.js package.json).

You can run

deno task

to get a list of all available tasks.

VS Code extension

There is an official VS Code extension for Deno: vscode-deno.

It should already be enabled for the workspace, for more information check the documentation.

JetBrains also offers a plugin for WebStorm and other JetBrains IDEs.

Local execution

To watch for file changes during development, run

deno task dev

To execute the application without watching for file changes run

deno task start

or run

deno task docker

to execute the application in a local docker container.

Afterwards you can access the graphql playground here:

http://localhost:8006/graphql

Continuous Integration and Deployment

Skipping parts of CI

Sometimes, changes don't need to be verified by the full pipeline, e.g. changes in linting or documentation.

noenv Branches

When you prefix your branch name with noenv/ (e.g. noenv/my-readme-update) the pipeline only lints & builds, but does not publish, deploy or run e2e test. This saves quite some time. Obviously, many things go untested so only use this if "you know what you're doing".

Runtime / Deployment

Configuration