shado-puppet v0.0.2

Shadō Puppet

By Shadō Network.

This framework is a work in progress! Breaking changes might occur, use at your own discretion.

Installation

• Clone the @shado-network/shado-puppet repository and navigate into the new directory
• Run npm install to install the framework dependencies

Configuration

App

• Create a new .env file in the root directory and update it with the correct config and secrets
  • See the .env.template file for reference

Puppet(s)

• Create a new puppet file inside the ./include/ folder
  • Name it after the puppet's id for easy reference
    • Eg. ./include/{puppet_id}.ts
  • See the puppet example files for reference:
    • ./include/good.ts
    • ./include/evil.ts
  • Optionally create a .env.{puppet_id} to separate puppet secrets:
    • See the .env.puppetid.template file for reference

Getting started

Run the shado-puppet framework, in development or production mode, with your own puppet files. Or, try it with the supplied example puppets.

The --puppets argument expects one or more puppet ids that have been set in the puppet files.

# Development mode
npm run dev --puppets="good,evil"

# Production mode
npm run build && npm run start --puppets="good,evil"