Invos

02_developer_setup_guide

3 min read

Developer Machine Setup Guide

Welcome to the team! This guide will walk you through setting up your new machine for development. The goal is to get your computer ready to work on any of our projects.

For instructions on how to set up a specific project, please refer to the 05_local_development_environment_setup.md guide in the 03_development_management directory.

For macOS

1. Install Homebrew

Homebrew is a package manager for macOS that makes it easy to install software.

Open your terminal and run the following command:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. Install Core Tools with Homebrew

# Install Git (even though macOS comes with it, this ensures you have the latest version)
brew install git
 
# Install a text editor (if you don't have one)
# brew install --cask visual-studio-code
 
# Install other useful tools
brew install wget

3. Set up Git

Configure Git with your name and company email address.

git config --global user.name "Your Name"
git config --global user.email "your.name@our-company.com"

4. Set up SSH Key for GitHub

An SSH key allows you to connect to GitHub without needing to enter your username and password every time.

  • Generate a new SSH key:

    ssh-keygen -t ed25519 -C "your.name@our-company.com"

    Press Enter to accept the default file location and, for now, you can leave the passphrase empty.

  • Add the SSH key to the ssh-agent:

    eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

  • Add the SSH key to your GitHub account:

    1. Copy the public key to your clipboard: 
      pbcopy < ~/.ssh/id_ed25519.pub
    2. Open GitHub and go to Settings > SSH and GPG keys.
    3. Click New SSH key, give it a title (e.g., “MacBook Pro”), and paste the key into the “Key” field.

5. Install Node.js via nvm

nvm (Node Version Manager) is a tool that allows you to install and manage multiple versions of Node.js on your machine.

  • Install nvm:

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

    (Check the nvm GitHub page for the latest version of this command). You will need to close and reopen your terminal after installing.

  • Install the latest LTS version of Node.js:

    nvm install --lts
nvm use --lts
nvm alias default 'lts/*'

    This will install the latest Long-Term Support version of Node.js and set it as the default.

6. Install Global npm Packages

# Install Wrangler, the Cloudflare CLI
npm install -g wrangler
 
# Install TypeScript and other useful tools
npm install -g typescript ts-node
  • If you haven’t already, install Visual Studio Code.
  • Open VS Code and go to the Extensions view. Install the following extensions, which are standard for our projects:
    • dbaeumer.vscode-eslint (ESLint)
    • esbenp.prettier-vscode (Prettier - Code formatter)
    • EditorConfig.EditorConfig (EditorConfig for VS Code)
    • eamodio.gitlens (GitLens)
    • Dotenv.dotenv-vscode (DotENV)

Your machine is now set up and ready for development! You can now proceed to clone your first project repository and follow its local setup guide.

Graph View

Backlinks