Skip to content
This repository has been archived by the owner on Nov 7, 2022. It is now read-only.

Latest commit

 

History

History
91 lines (58 loc) · 3.69 KB

README.md

File metadata and controls

91 lines (58 loc) · 3.69 KB
Raw

This code has moved to @adobe/helix-sidekick-extension

Franklin Sidekick

Browser-based helper for authoring Franklin projects

Status

codecov CircleCI GitHub license GitHub issues LGTM Code Quality Grade: JavaScript semantic-release

Installation

Bookmarklet

Navigate to https://www.hlx.live/tools/sidekick/ and follow the instructions.

Browser Extension

See https://github.com/adobe/helix-sidekick#readme

Configuration

Franklin Sidekick supports a number of (optional) configuration options developers can add to the project to maximize the Sidekick experience.

See the API documentation.

Usage

Refer to the Sidekick documentation to learn more about its features.

Development

Build

$ npm install

Test

$ npm test

Lint

$ npm run lint

Testing a development version of the module or bookmarklet

Every development branch in this repository will be mirrored in https://github.com/adobe/helix-website with a sidekick- prefix to enable enable branch testing:

  1. Push changes to a branch issue-77
  2. Note the sidekick-issue-77 branch in https://github.com/adobe/helix-website/branches
  3. Go to https://sidekick-issue-77--helix-website--adobe.hlx.page/tools/sidekick/ to install a development version of the bookmarklet for your project

Note: Mirrored development branches in https://github.com/adobe/helix-website/branches must be deleted manually when no longer needed.

Local testing

You can leverage Franklin CLI for local testing. If you haven't already installed it, run: npm i -g @adobe/helix-cli

Testing a local Sidekick version

  1. Run npm start on your local checkout of this repository
  2. Go to `http://localhost:3001/ and follow the instructions.

Testing a local project config

If you want to test a config file before deploying it to your project:

  1. Run hlx up on your local checkout of the project repository
  2. Install a Sidekick bookmarklet for your project: https://www.hlx.live/tools/sidekick/
  3. Edit the bookmarklet URL by appending ,"devMode":"true" after "ref":"*" (* being your project branch)
  4. Click the bookmarklet to launch Sidekick using your local config

Deployment

The Sidekick module and bookmarklet gets staged automatically each time a pull request is merged into main.

  1. Go to helix-website pull requests
  2. Click the Sidekick Release Candidate PR
  3. Add a comment listing the helix-sidekick PR(s) included in this release
  4. Get a team member to review the Sidekick RC. The PR is based on a sidekick-rc-* branch (* being a random ID) so the RC can be tested at: https://sidekick-rc-*--helix-website--adobe.hlx.page/tools/sidekick/
  5. Once approved, merge the RC PR to deploy the changes into production