titles-workflow-server v3.40.0

Titles Workflow Server

Basic setup for typescript / fastify.

• start: yarn start
• build: yarn build
• test: yarn test

Docker Container

To start the fastify API server in a docker container:

• docker build . -t titles-workflow-server-node
• docker run -p 3002:3002 title-workflow-server-node

To start the fastify API server in a docker-compose stack:

• docker-compose build
• docker-compose up -d (run detached in the background)
• docker-compose down to stop if running as background process
• docker-compose logs to see log output (append -f to follow log output)

Setup

1. Get access to the Auto Approve 1Password vault.
2. Pull the .env file (Titles-workflow-server .env for local development) down from the vault. Place the file in the root of this repository.
3. Run yarn install to download node modules.

Database Setup

1. You will need Docker Compose. If you're using a Mac or Windows, you can download Docker Desktop, which also installs Docker Compose.
2. Run docker-compose up -d from the root of this repository. This will use the Dockerfile and docker-compose.yml file to create a few images and a container. The container will contain the postgreSQL DB.
3. Run yarn db-migrate-dev to create the titles-workflow database within the postgres server and apply migrations to the database. If it cannot find prisma, you may need to install it globally (npm install -g prisma).

If you ever need to kill the DB container, run docker-compose down

Semantic Versioning & Commit Naming Convention

Our commit message format is as follows:

Tag: Short description (fixes #1234)

Longer description here if necessary

The first line of the commit message (the summary) must have a specific format. This format is checked by semantic-release.

The Tag is one of the following:

• Fix - for a bug fix.
• Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
• New - implemented a new feature.
• Breaking - for a backwards-incompatible enhancement or feature.
• Docs - changes to documentation only.
• Build - changes to build process only.
• Upgrade - for a dependency upgrade.
• Chore - for refactoring, adding tests, etc. (anything that isn't user-facing).

Learn more about how versioning changes by Tag here: https://github.com/semantic-release/commit-analyzer/blob/master/lib/default-release-rules.js