Holi App Volunteering

The backend for handling Volunteering projects, including a GraphQL API for Volunteering.

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

Getting started

Setup

Install deno in version 1.40.1.

as well as Velociraptor.

Code style

Linting:

vr lint

Formatting:

vr 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:

vr 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

vr 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:

vr cache

Testing

Tests can be executed with

vr test

(Test filenames should end on a _test prefix).

To get information about test coverage use

vr coverage

For more information, e.g. on how to create different coverage formats, see the documentation

Tasks

We use Velociraptor to execute scripts that are defined beneath velociraptor > scripts in deno.json (similiar to scripts defined in Node.js package.json).

You can run

vr

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

Environment Variables

If you haven't done so yet, please cp .envrc.local.template .envrc.local. Then, within .envrc.local, set the environment variables required for the service to run. Please see the configuration section to learn about the possible environment values, their purpose and where to find the values.

ML Recommendations

In the context of HOLI-8190 recommendations were introduced. Recommendations are based on embeddings that were previously created by an ML pipeline and stored in a Postgres database within Google Cloud. These are currently not locally available. The endpoints engagementRecommendations & engagementRecos rely on a connection to the aforementioned database that is only accessible to holi employees (unless running the service with the environment variable FAKE=true).

Running

To watch for file changes during development, run

vr dev

To execute the application without watching for file changes run

vr start

or run

vr docker

to execute the application in a local docker container.

Afterwards you can access the graphql playground here:

http://localhost:8004/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