> For the complete documentation index, see [llms.txt](https://docs.exile.watch/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exile.watch/projects/malachai/contributing.md).

# Contributing

<figure><img src="https://694473604-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOzA1rSlMPE3i2X5tlqgu%2Fuploads%2FZCdzczA729HO2CsFnhUE%2Fimage.png?alt=media&amp;token=3373666c-de2d-4ae5-985d-8c0be1fbeadd" alt="" width="200"><figcaption><p>exile.watch logo</p></figcaption></figure>

## [Prerequisites](/development/prerequisites.md)

## Development

### 1. [Fork @exile-watch/malachai repo](https://github.com/exile-watch/malachai)

### 2. [Create GitHub PAT token](/development/generating-github-pat.md)

### 3. [Create .npmrc file](/development/.npmrc-file.md)&#x20;

### 4. Install dependencies & start script

```bash
# project root
$: nvm use # uses node version that's defined in .nvmrc
$: npm i # install dependencies
$: cd packages/snap-gyazo-thumbnail && npm run dev # run the app locally
```

### 5. Loading extension in chrome

#### 5.1. Head over to `chrome://extensions` and enable Developer Mode.

Upper right corner, toggle the `Developer Mode` switch

#### 5.2. Click on "Load Unpacked" and navigate to `malachai` extension's `build/chrome-mv3-dev` (or `build/chrome-mv3-prod`) directory.

Running `npm run dev` will generate `build/chrome-mv3-dev`\
Running `npm run build` will generate `build/chrome-mv3-prod`

`build/*` dir is generated at `./packages/snap-gyazo-thumbnail`

#### 5.3. Head over to [https://gyazo.com/:gif\_id](https://gyazo.com/41c10c1cc7d06c7d5fee3287cdf58724) to see the extension in action

`malachai` is using [plasmo](https://docs.plasmo.com/), the all-in-one platform that makes it easy for browser extension developers to create, test, and publish extensions

<figure><img src="https://694473604-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOzA1rSlMPE3i2X5tlqgu%2Fuploads%2FijmhjM1zCiuoDTArMZii%2Fimage.png?alt=media&amp;token=b92d478b-28ca-45d9-8b52-0a48cdc612cb" alt=""><figcaption><p>Redirect button highlight</p></figcaption></figure>

<figure><img src="https://694473604-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOzA1rSlMPE3i2X5tlqgu%2Fuploads%2Fiwk4yssg24sDYoKMpgm5%2Fimage.png?alt=media&amp;token=ba6009b8-08b5-432a-a1b9-2328eee44a94" alt=""><figcaption><p>Thumbnail creation button highlight</p></figcaption></figure>
