Setup¶

This page describes how to set up the local development environment for gaslamp.

While Google Apps Script (GAS) runs in the cloud and cannot be fully emulated locally, this setup allows you to develop, test, and build TypeScript/JavaScript code effectively on your machine using familiar tools.

Git¶

We use git for source code management.

It is required for cloning the repository, tracking changes, and managing development branches.

We also recommend using git worktree for parallel development within your local environment, so you can work on multiple branches without switching branches back and forth.

Bash

brew install git
git --version
# git version 2.53.0

Node + npm¶

We use npm as the package manager for TypeScript and JavaScript dependencies.

Node.js is required to run tools like tsc, vitest, rollup, and clasp used in this project.

Bash

brew install node

node --version
# v25.8.1

npm --version
# 11.11.0

Python + uv¶

We use uv as a fast Python package manager, mainly to install tools like mkdocs-material, commitizen, pre-commit within the project environment.

This ensures that all development dependencies are isolated and reproducible.

Although uv itself does not depends on Python, it installs and manages Python packages. You may also want to check your Python version when working with MkDocs plugins.

Bash

brew install python
brew install uv

python3 --version
# Python 3.12.7

uv --version
# uv 0.10.12 (Homebrew 2026-03-19 aarch64-apple-darwin)

uv sync