Skip to content

stoked-cenv/cenv-mono

Repository files navigation

cenv

STOKED

A well considered cli and Node.js library for helping manage application, infrastructure, and configuration management.

node.js version pnpm version typescript version Version cdk version

overview

cenv inspects your packages and looks for specific conventions to identify cenv modules within each package. There are currently 5 different types of cenv modules, LIB, EXEC, PARAMS, DOCKER, and STACK. A package must have at least one cenv module in order to take advantage of the cenv tool.

The PARAMS module leverages AWS AppConfig and AWS Parameter Store to manage application parameter configuration. The DOCKER module provides a mechanism to create an AWS ECR repository for the package containers and build and push the packages containers to the repo. Finally, the STACK module uses AWS Cdk to deploy cloudformation stacks representing the infrastructure and applications contained in the packages.

pre-requisites

Getting Started

install the cli:

#npm
npm i -g @stoked-cenv/cli 

or

#yarn
yarn global add @stoked-cenv/cli 

configuring aws

 cenv configure
STOKED
# aws profile used to access the aws account you are deploying to.. if one doesn't already exist run "aws configure" first
AWS_PROFILE: (stoked)

# environment region
AWS_REGION: (us-east-1)

# environment name
ENV: (dev)

# everything will point to subdomains below this by default
ROOT_DOMAIN: (stokedconsulting.com)
full stack example project coming soon!

cenv-mono contents: the packages

This monorepo contains 3 packages which will be explained here. The packages are cli, lib, params, and ui.

The cli package contains the code for the end user command line interface tool.

The lib package contains the library code that can be consumed by external libraries to manage cenv parameters in their application stacks.

The ui package contains the ui code for the cli built on https://github.com/chjj/blessed.

support

Call your congressperson. When that doesn't work contact Brian Stoker.

license

MIT Licensed

STOKED