Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.08 KB

README.md

File metadata and controls

53 lines (35 loc) · 1.08 KB

MagicBell Ping VSCode Extension

Show GitHub notifications in VSCode.

Note

This package is in early alpha and is subject to change.

Requirements

  • Node 18.9 or higher
  • VSCode 1.73 or higher

Setup & Development

To run Ping, you'll need to create a .env.development file and fill in the fields as demonstrated in the empty .env. Then, run yarn in the repo root to install all dependencies, and yarn start in to start all package builders in watch mode.

yarn
yarn start

Testing the extension

  1. Build:
yarn build:dev
  1. Run:
yarn dev

Configuration

Open Settings in VSCode, and search for "ping". Please enter:

  • Ping: Api Key; Your MagicBell API Key
  • Ping: User Hmac; Your MagicBell HMAC, which is a hash based on your GitHub username and the MagicBell project secret key.
  • Ping: Username: Your GitHub username

It might be necessary to reload the window after changing the configuration.

Installing the extension locally

Run yarn build && yarn vscode:deploy:local.

yarn build:dev
yarn vscode:deploy:local