apps-script-starter

by labnol

Setup a local development environment for Google Apps Script and build GSuite addons.

518 Stars 97 Forks Last release: 8 months ago (1.0) MIT License 137 Commits 1 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Google Apps Script Development πŸ’―

The Google Apps Script Starker kit supports the new V8 JavaScript runtime that powers Chrome and Node.js. You can write code using modern ECMAScript syntax like Arrow functions, Classes, Template Literals, Destructuring and more.

Google Apps Script Development with ES6

Please follow the πŸ‘‰ step-by-step video tutorial πŸ‘ˆ for quickly getting started with Apps Script development inside Visual Studio Code.

You can build GSuite add-ons (for Google Docs, Slides, Gmail and Google Sheets), web applications and workflow automation routines with next-generation JavaScript.

The starter kit is used by Digital Inspiration for building popular Google add-ons including Gmail Mail Merge, Google Forms Notifications and Document Studio.

Build with Google Apps Script πŸš€

Setting up a modern development environment for building Google Apps Script projects is easy and quick (video tutorial).

You also need to install Node.js which includes the npm package manager.

:package: Getting Started

1. Clone the repository and install npm dependencies and utilities.

git clone https://github.com/labnol/apps-script-starter my-project
cd my-project
npm install

Update: The

git clone
command adds a .git folder to your folder that pertains to the Apps Script Starter project and not your local project. You should either re-init the repository or use
degit
to clone the repository.
npx degit labnol/apps-script-starter my-project

2. Log in to Google clasp and authorize using your Google account.

npx clasp login

3. Create a new Google Script bound to a Google Sheet (or set the type as standalone to create a standalone script in your Google Drive)

npx clasp create --type sheets --title "My Apps Script Project" --rootDir ./dist

4. Include the necessary OAuth Scopes in the appsscript.json file

  1. Deploy the project (development)
npm run deploy

The

dist
directory contains the bundled code that is pushed to Google Apps Script.

6. Deploy the project (production mode)

npm run deploy:prod

Google Apps Script - Setup Development Environment

Enable JavaScript v8 Runtim

Inside the Google Apps Script editor, select View > Show project manifest to open the

appsscript.json
manifest file in the editor. Add a new
runtimeVersion
field and set the value to
V8
. Save your script.

Google Apps Script - v8 Runtime

Development vs Production mode

In production mode, the function names and variable names are shrinked and the output code is auto-minified. The production flag is not recommended for testing and debugging the Apps Script code.

The .claspignore file

The

.claspignore
file allows you to specify file and directories that you do not wish to not upload to your Google Apps Script project via
clasp push
.

The default

.claspignore
file in the Apps Script Starter kit will push all the JS and HTML inside the
rootDir
folder and ignore all the other files.

:beginner: Using Git with Google Apps Script

Google Apps Script - Github

Create a new repository in Github and make a note of the URL of the new repository. Next, open the terminal and run the above commands to push your Apps Script project to Github.

Custom Google Sheet function

Please read the tutorial on how to write custom functions for Google Sheets using Apps Script.

:fire: Meet the Developer

Amit Agarwal is a web geek, Google Developers Expert (GSuite, Google Apps Script) and author of labnol.org, a popular tech how-to website.

He frequently uses Google Apps Script to automate workflows and enhance productivity. Reach him on Twitter or email

[email protected]

:cherry_blossom: Contribution

Contributions and feature requests are welcome. If you are using the Google Apps Script starter package and fixed a bug for yourself, please consider submitting a PR!

:lock: License

MIT License (c) Amit Agarwal

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.