@beecode/msh-base-frame

msh-base-frame

• Install
• Usage
• Using private temp repo (Github only)

Install

npm i -g @beecode/msh-base-frame

Usage

Follow instruction inside template repo (STARTER_INSTRUCTIONS.md)
STARTER_INSTRUCTIONS.md example:

# Template file `.base-frame`

//json
{
  "template": {
    "projectName": "msh-project",
    "gitTeam": "beecode-rs",
    "npmPackagePrefix": "@beecode/"
  },
  "gitZipUrl": "https://github.com/beecode-rs/ts-lib-starter/archive/refs/heads/main.zip"
}

Create a folder for your project (my-new-project)
Create .base-frame file in project folder

my-new-project/
 └── .base-frame

And replace template data with your data

{
  "template": {
    "projectName": "my-new-project",
    "gitTeam": "awesome-team",
    "npmPackagePrefix": "@awesome-team/"
  },
  "gitZipUrl": "https://github.com/beecode-rs/ts-lib-starter/archive/refs/heads/main.zip"
}

Then execute command from the project root

$> msh-base

Using private temp repo (Github only)

If you have a private repo you will need to generate Person Access Token and place it in .base-frame.user.json located in your users home dir (~/.base-frame.user.json)

{
  "githubPersonAccessToken": "ghp_JiZ#################################"
}

How to generate Github Personal Access Token