@rblock919/server-module-kit NPM

Server-Side Module Kit

Server-Side Module Kit is a starter kit for creating new server-side nestJS shared npm module.

Stack

NestJS

Project Structure

    ./Makefile          -project automation orchestrator.
    ./config            -project configuration files
    ./scripts           -project scripts
    ./tests             -project test scripts

Project Configuration

    ./config/base   -common project configuration

Project Automation

digraph project {
    label="Project"
    fontname="Roboto"

    node [
        shape="note"
        color="blue"
    ]

    Project -> Install

    Project -> Analyze -> Build -> Test [
        color="green"
    ]

    Build -> Publish [
        label="Packaging path"
        color="purple"
    ]

    Build -> Deploy [
        label="Deployment Path"
        color="orange"
    ]
}

Project Scripts

    All scripts can be called via Make (as defined in the Makefile).
    Each script can orchestrate/delegate to other tools as needed to perform their function.

    ./scripts/functions.sh      -shared bash functions.
    ./scripts/install.sh        -installs development dependencies and tooling.

    ./scripts/analyze.sh        -project analysis script
    ./scripts/build.sh          -project build script
    ./scripts/test.sh           -project test executor script
    ./scripts/deploy.sh         -project deployment script
    ./scripts/publish.sh        -project artifact publishing script

    ./scripts/start.sh          -project startup script
    ./scripts/stop.sh           -project shutdown/stop script