Setup a local development environment for Google Apps Script and build GSuite addons.
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:
Please follow the 👉 step-by-step video tutorial 👈 for quickly getting started with Apps Script development inside Visual Studio Code.
You also need to install Node.js which includes the npm package manager.
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
git clonecommand 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
degitto 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
npm run deploy
distdirectory contains the bundled code that is pushed to Google Apps Script.
6. Deploy the project (production mode)
npm run deploy:prod
Inside the Google Apps Script editor, select View > Show project manifest to open the
appsscript.jsonmanifest file in the editor. Add a new
runtimeVersionfield and set the value to
V8. Save your script.
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.
.claspignorefile allows you to specify file and directories that you do not wish to not upload to your Google Apps Script project via
.claspignorefile in the Apps Script Starter kit will push all the JS and HTML inside the
rootDirfolder and ignore all the other files.
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.
Please read the tutorial on how to write custom functions for Google Sheets using Apps Script.
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!