> For the complete documentation index, see [llms.txt](https://wiki.4thtech.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.4thtech.io/developers/architecture/build.md).

# Build from source

Build the Encryptor extension from source and load it in Chrome.

{% hint style="info" %}
**Status: Production-ready, stable.** Encryptor is supported; no new features are planned. Last update: 18 Apr 2024 (version 0.1.0).
{% endhint %}

Source: [github.com/4thtech/encryptor-extension](https://github.com/4thtech/encryptor-extension). It is a Vite + Vue project using `@crxjs/vite-plugin`.

## Requirements

* Node.js 14.18 or later (package `engines`).
* npm.

## Steps

1. Clone the repository and install dependencies:

```shell
npm install
```

2. Start the development build:

```shell
npm run dev
```

3. In Chrome open `chrome://extensions`, switch on **Developer mode**, select **Load unpacked** and choose the build folder.
4. For a production bundle run `npm run build`. It runs a type check (`vue-tsc --noEmit`) and then `vite build`. The README says the contents of the `build` folder are what you submit to the Chrome Web Store.

## Notes

* The extension name and manifest are in `src/manifest.ts`; the version comes from `package.json`.
* A build loaded unpacked has a different extension ID from the store version. The SDK connector contacts the store ID, so apps will not detect an unpacked build without changing the SDK's ID.
* The README comes from the `create-chrome-ext` template; some of its text (such as the options page) does not apply to this project.

See [Licence](https://wiki.4thtech.io/developers/architecture/licence.md).
