Ship in 5 Minutes

This guide walks you through the minimal path to deploying a working add-on with authentication.

1. Clone and Install

git clone <your-repo-url>
cd boilerplate-google-extension

# Install backend dependencies
cd web && yarn install
cp .env.example .env.local
cd ..

# Install addon dependencies (requires Node 18)
cd addon && nvm use 18 && yarn install && cd .. 

2. Create Google Cloud Project

Before setting up your addon, you need a Google Cloud Project:

1. Go to Google Cloud Console
2. Click Select a project > New Project
3. Name your project and click Create
4. Copy your Project Number (a ~12 digit number like 123456789012)

You'll need this Project Number during the addon setup.

3. Deploy the Add-on

cd addon
yarn run login    # Login to clasp (first time only)
yarn run setup    # Interactive setup wizard
yarn run deploy   # Build and push to Google Apps Script

The setup wizard prompts you for:

• Your Google Cloud Project Number
• A name for your add-on
• Which Google apps to target (Sheets, Docs, Slides, Forms)

What "Working" Looks Like

When everything is configured correctly:

1. Opening the sidebar shows the addon
2. The authentication still needs to be setup

🎉 You Rock!

Your addon should be deployed and ready for next steps. You are getting the hang of it!

Next Steps