{"id":13535357,"url":"https://github.com/adobe/helix-sidekick","last_synced_at":"2025-04-02T01:30:30.732Z","repository":{"id":37991490,"uuid":"372401116","full_name":"adobe/helix-sidekick","owner":"adobe","description":"Browser-based helper for authors on Helix projects","archived":true,"fork":false,"pushed_at":"2022-11-07T07:13:11.000Z","size":1934,"stargazers_count":4,"open_issues_count":1,"forks_count":10,"subscribers_count":26,"default_branch":"main","last_synced_at":"2024-11-02T23:32:48.665Z","etag":null,"topics":["helix","helix2","helix3","webapp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adobe.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-31T06:12:46.000Z","updated_at":"2024-07-26T23:27:49.000Z","dependencies_parsed_at":"2023-01-21T18:45:58.871Z","dependency_job_id":null,"html_url":"https://github.com/adobe/helix-sidekick","commit_stats":null,"previous_names":[],"tags_count":89,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fhelix-sidekick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fhelix-sidekick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fhelix-sidekick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fhelix-sidekick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adobe","download_url":"https://codeload.github.com/adobe/helix-sidekick/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246738373,"owners_count":20825775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helix","helix2","helix3","webapp"],"created_at":"2024-08-01T08:00:54.767Z","updated_at":"2025-04-02T01:30:30.443Z","avatar_url":"https://github.com/adobe.png","language":"JavaScript","funding_links":[],"categories":["Steps"],"sub_categories":[],"readme":"**This code has moved to [@adobe/helix-sidekick-extension](https://github.com/adobe/helix-sidekick-extension)**\n\n# Franklin Sidekick\n\n\u003e Browser-based helper for authoring Franklin projects\n\n\n\n## Status\n[![codecov](https://img.shields.io/codecov/c/github/adobe/helix-sidekick.svg)](https://codecov.io/gh/adobe/helix-sidekick)\n[![CircleCI](https://img.shields.io/circleci/project/github/adobe/helix-sidekick.svg)](https://circleci.com/gh/adobe/helix-sidekick)\n[![GitHub license](https://img.shields.io/github/license/adobe/helix-sidekick.svg)](https://github.com/adobe/helix-sidekick/blob/master/LICENSE.txt)\n[![GitHub issues](https://img.shields.io/github/issues/adobe/helix-sidekick.svg)](https://github.com/adobe/helix-sidekick/issues)\n[![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/adobe/helix-sidekick.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/adobe/helix-sidekick)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\n## Installation\n\n### Bookmarklet\n\nNavigate to https://www.hlx.live/tools/sidekick/ and follow the instructions.\n\n### Browser Extension\n\nSee https://github.com/adobe/helix-sidekick#readme\n\n## Configuration\n\nFranklin Sidekick supports a number of (optional) configuration options developers can add to the project to maximize the Sidekick experience. \n\nSee the [API documentation](docs/API.md#sidekickConfig).\n\n## Usage\nRefer to the [Sidekick documentation](https://www.hlx.live/docs/sidekick) to learn more about its features.\n\n## Development\n\n### Build\n\n```bash\n$ npm install\n```\n\n### Test\n\n```bash\n$ npm test\n```\n\n### Lint\n\n```bash\n$ npm run lint\n```\n\n### Testing a development version of the module or bookmarklet\n\nEvery development branch in this repository will be mirrored in https://github.com/adobe/helix-website with a `sidekick-` prefix to enable enable branch testing:\n\n1. Push changes to a branch `issue-77`\n2. Note the `sidekick-issue-77` branch in https://github.com/adobe/helix-website/branches\n3. Go to `https://sidekick-issue-77--helix-website--adobe.hlx.page/tools/sidekick/` to install a development version of the bookmarklet for your project\n\n_Note: Mirrored development branches in https://github.com/adobe/helix-website/branches must be deleted manually when no longer needed._\n\n### Local testing\n\nYou can leverage Franklin CLI for local testing. If you haven't already installed it, run: `npm i -g @adobe/helix-cli`\n\n#### Testing a local Sidekick version\n\n1. Run `npm start` on your local checkout of this repository\n2. Go to `http://localhost:3001/ and follow the instructions.\n\n#### Testing a local project config\n\nIf you want to test a [config](#configuration) file before deploying it to your project:\n1. Run `hlx up` on your local checkout of the project repository\n2. Install a Sidekick bookmarklet for your project: https://www.hlx.live/tools/sidekick/\n3. Edit the bookmarklet URL by appending `,\"devMode\":\"true\"` after `\"ref\":\"*\"` (`*` being your project branch)\n4. Click the bookmarklet to launch Sidekick using your local config\n\n## Deployment\n\nThe Sidekick module and bookmarklet gets staged automatically each time a pull request is merged into `main`.\n1. Go to [`helix-website` pull requests](https://github.com/adobe/helix-website/pulls)\n1. Click the _Sidekick Release Candidate_ PR\n1. Add a comment listing the `helix-sidekick` PR(s) included in this release\n1. 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:\n   `https://sidekick-rc-*--helix-website--adobe.hlx.page/tools/sidekick/`\n1. Once approved, merge the RC PR to deploy the changes into production\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadobe%2Fhelix-sidekick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadobe%2Fhelix-sidekick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadobe%2Fhelix-sidekick/lists"}