Webframe Dev Tool

Webframe developer cli to sync platform changes with the project's source code.

Setup

1. Create .webframerc file inside your project's root folder with this content:

{
  "apiKey": "<YOUR_API_KEY_TOKEN>",
  "apiSecret": "<YOUR_API_SECRET_TOKEN>"
}

2. Make sure to exclude .webframerc from git version control by adding this to .gitignore:

.webframerc

3. Create webframe.config.json file with this content:

// !IMPORTANT - remove all comment lines in the actual json file
{
  "projects": [
    {
      "id": "projectId1",
      // Directory path for saving Webframe generated code (relative to the project's root folder)
      "rootDir": "./webframe",
      // Monorepository package.json name
      "name": "webframe",
      // Optional project version number, following semantic versioning (default is "latest")
      "version": "^1.0.0"
    }
  ],
  // Optional configs - below is the default
  "endpoint": "//api.webframe.app",
  "typescript": false
}

Usage

# Sync the last published project version with the source code in the local repository
npx webframe-dev pull

# Sync the latest project changes with the source code in the local repository
npx webframe-dev sync

# Auto-sync the latest project changes with the source code in the local repository
npx webframe-dev sync --watch