Skip to content

README.md

Latest commit

 

History

History
58 lines (34 loc) · 2.14 KB

README.md

File metadata and controls

58 lines (34 loc) · 2.14 KB

checkFrontierSetup

A tool to check if a developer's machine is set up correctly with the tooling and access needed for FamilySearch Frontier development. Also includes macSetup.sh, an interactive onboarding script that automates the full setup process for new developers.

macSetup.sh — New Developer Onboarding

macSetup.sh is an interactive, idempotent setup script for macOS. It walks a new developer through every step needed to be productive on Frontier. Re-running the script is safe — completed steps are automatically detected and skipped.

Running the script

bash <(curl -fsSL https://raw.githubusercontent.com/fs-webdev/checkSetup/master/macSetup.sh)

Alternatively, download and inspect before running:

curl -fsSL https://raw.githubusercontent.com/fs-webdev/checkSetup/master/macSetup.sh -o macSetup.sh
bash macSetup.sh

What the script does

Walks through setting up Xcode CLT, GitHub org access, git config, nvm + Node 24, Artifactory npm registry, the Frontier CLI (@fs/fr-cli), and optional tools like Homebrew and Watchman. Some steps require browser actions (GitHub, Artifactory) and will pause so you can complete them. macOS only.

After the script finishes

Run source ~/.zshrc (or open a new terminal) to apply all shell changes.

checkSetup — Environment Verification Tool

Checks that your machine has valid versions of Node and npm, that you're using nvm, and that ~/.netrc and ~/.npmrc are configured correctly (by making a test call to Artifactory and to a private fs-webdev GitHub repo).

You'll get a green success message if everything is in order, or red error messages for any problems.

Usage

npx fs-webdev/checkSetup

Contractors

Supply a private repo name to check against an org-specific repo instead of the default:

npx fs-webdev/checkSetup lightyear-react

Maintainer Warning

This package must not depend on any private GitHub repos or @fs Artifactory modules. It is run during onboarding before those credentials are fully configured, so any such dependency will cause it to fail for the developers it's meant to help.