qaskx.template/_generator/default/project/definitions/golang/README_QX.md

1.1 KiB

Project {{.Name}}

One Paragraph of {{.Name}} project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

The assumption is that you have the following commands in your execution path:

  1. qaskx-cli - The qaskx tool
  2. go-blueprint - The Golang blueprint command
  3. code - Microsoft Visual Code
  4. make - The legacy make command

Each of the above are executables available on Linux, Windows and MacOS

MakeFile

Build the application

qaskx-cli run -t make:build

Run the application

make run

Create DB container

make docker-run

Shutdown DB Container

make docker-down

DB Integrations Test:

make itest

Live reload the application:

make watch

Run the test suite:

qaskx-cli run -t make:test

Clean up binary from the last build:

make clean