@junobuild/vite-plugin
v0.0.19
Published
A Vite plugin for Juno
Downloads
1,500
Maintainers
Readme
Juno Vite Plugin
A Vite plugin for Juno.
Getting started
The plugin automatically loads your Satellite and Orbiter IDs.
With these values, you can instantiate Juno in your code without the need to manually define environment variables.
await Promise.all([
initJuno({
satelliteId: import.meta.env.VITE_SATELLITE_ID
}),
initOrbiter({
satelliteId: import.meta.env.VITE_SATELLITE_ID,
orbiterId: import.meta.env.VITE_ORBITER_ID
})
]);
Environment variables
Those following environment variables are injected by this plugin:
| Environment variable | Value in mode development
| Value for other modes |
| ------------------------- | ----------------------------- | ------------------------------------------------------------------ |
| VITE_SATELLITE_ID | jx5yt-yyaaa-aaaal-abzbq-cai
| The Satellite ID for the mode
from your Juno configuration file. |
| VITE_ORBITER_ID | undefined
| The Orbiter ID from your Juno configuration file. |
| VITE_INTERNET_IDENTITY_ID | rdmx6-jaaaa-aaaaa-aaadq-cai
| rdmx6-jaaaa-aaaaa-aaadq-cai
|
| VITE_ICP_LEDGER_ID | ryjl3-tyaaa-aaaaa-aaaba-cai
| ryjl3-tyaaa-aaaaa-aaaba-cai
|
| VITE_ICP_INDEX_ID | qhbym-qaaaa-aaaaa-aaafq-cai
| qhbym-qaaaa-aaaaa-aaafq-cai
|
VITE_
is the default prefix used by Vite. It can be customized as described in Vite's documentation.
Installation
npm i @junobuild/vite-plugin -D
Usage
// vite.config.js
import juno from '@junobuild/vite-plugin';
export default defineConfig({
plugins: [juno()]
});
Options
The plugins can be initialized with the following options:
container
:true
to use Juno Docker with default options, or specify an object.
The object accepts the following parameters:
- An optional
url
asstring
, representing the container URL including the port, e.g.http://127.0.0.1:8000
. - An optional list of
modes
for which the container should be used.
By default, the container is mounted only in development
mode.
// vite.config.js
import juno from '@junobuild/vite-plugin';
export default defineConfig({
plugins: [
juno({
container: true
})
]
});
License
MIT © David Dal Busco