In this guide, we will discuss how to setup a Vite project, that uses Onboardbase to manage its secrets(environment variables)


This section assumes you already have a project set up in Onboardbase Dashboard. If you don't, please create an account and get started!

Create a Vite Project

We will be deploying the demo version of the Vite CLI project.

From anywhere comfortable in your terminal, run:

// Create a new Vite App using `vite@latest`. Follow the prompt if you don't have one already
$ npm create vite@latest

Change the directory into the vite app folder you just created

cd my-app

Then, change into the project folder cd my-app and add a remote git URL.

git remote add origin [REMOTE_GIT_URL]

git push --set-upstream origin main

Finally, start the project with:

   npm run dev

// or

   yarn dev

Install Onboardbase CLI

Follow the installation guide to set up Onboardbase CLI for your machine.

Verify installation with onboardbase --version, which would output the version of the CLI you just installed.

Authenticate Onboardbase CLI

From anywhere in your terminal, run onboardbase login, and accept to open the page in a browser.

On the authorization page, enter your email, and a confirmation link will be sent to the email; click on the link, and your CLI should be authorized. Check your terminal to confirm.

Setup Onboardbase CLI

After successful installation, from the Vite project directory in your terminal, run:

onboardbase setup

This would list all your projects, select the react project, select the development environment and accept to add .onboardbase.yaml to your .gitignore file.

This would create an .onboardbase.yaml file with all the details you selected during the setup, and the build script would use this to know which secrets to pull into your react project.

Building with Onboardbase CLI

Since we have all our secrets on Onboardbase, we would be using the build tool from Onboardbase to load secrets into the project.

To do this, modify your start script inside the package.json instead of having this:

"scripts": {
    "dev": "vite",
    "build": "vite build",
    "preview": "vite preview",

To this:

"scripts": {
    "dev": "onboardbase run --command=\"vite"",
    "build": "onboardbase run --command=\"vite build"",
    "preview": "onboardbase run --command=\"vite preview"",

Notice how we now use onboardbase run to run the start and build process instead of the base vite-scripts.

To test this, start the development server with:

yarn dev

// or

npm run dev

Which should import all your Onboardbase projects

The secrets are available through: process.env.VITE_APP_STORED_IN_ONBOARDBASE