/navis-push-worker

A worker used to send push notifications to Cephalon Navis

Primary LanguageDartMIT LicenseMIT

Navis Push Worker

style: very good analysis Powered by Mason License: MIT

A Very Good Project created by Very Good CLI.

Installation 💻

❗ In order to start using Navis Push Worker you must have the Docker (or docker equivalent) installed on your machine.

docker build --pull --rm -f "Dockerfile" -t navispushworker:latest "."

Before running the container make sure that you have the following environment variables:

Environment variable Description
SERVICE_ACCOUNT Your firebase service account
FIREBASE_PROJECT Your firebase project name
ENVIRONMENT Set to production to send notification or anything else to test without actually sending

Continuous Integration 🤖

Navis Push Worker comes with a built-in GitHub Actions workflow powered by Very Good Workflows but you can also add your preferred CI/CD solution.

Out of the box, on each pull request and push, the CI formats, lints, and tests the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses Very Good Analysis for a strict set of analysis options used by our team. Code coverage is enforced using the Very Good Workflows.

Running Tests 🧪

To run all unit tests:

dart pub global activate coverage 1.2.0
dart test --coverage=coverage
dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info

To view the generated coverage report you can use lcov.

# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html