claytoncountysd/integrationservice repository overview

⁠INSTALL

remember to:

npm i

git submodule update --init

(sidenote: troubleshooting submodules, try clearing out submodules in ./.git/config)

keep up to date with:

npm run pull-submodules

set up your env:

we use "env-cmd" to insert envvars into the running node env

• .env.develop (is the file used for the develop environment, for example)

(you may want to .gitignore .env* files in your project)

remember, we now use environment variables in our "Docker Compose" files⁠, like so:

version: {versionNum}
services:
  {ServiceName}:
    image: {org}/{dockerhub_img_name}:latest-dev
    hostname: {hostname}
    environment:
      {ENVVAR1}: "{val1}"
      {ENVVAR2}: "{val2}"
      {ENVVAR3}: "{val3}"

⁠SCRIPTS

available scripts: prebuild, build, prestart:develop, start:develop, dev, pull-submodules

⁠most useful scripts:

• npm run start:develop

(this triggers prestart:develop, which triggers build, which triggers prebuild) (all-in-one, basically)

• npm run dev

(this runs ts-node-dev, which means we get a "liveserver" - no need to rebuild :])

(NOTE: if there are errors, you DO need to re-run the above cmd)

• npm run pull-submodules

(does a git checkout develop on all submodules; followed by a git pull)

• npm run fix

(runs prettier (with --write option) on all ts/js/json files in src dir (recursively))