Development Environment Setup
Welcome to the team. This guide will get your Mac or Windows machine ready for development.
Mac Setup
Section titled “Mac Setup”1. Install Homebrew
Section titled “1. Install Homebrew”Homebrew is the package manager for macOS. Run this in Terminal:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"2. Install Git
Section titled “2. Install Git”brew install git3. Install NVM (Node Version Manager)
Section titled “3. Install NVM (Node Version Manager)”NVM lets you switch between Node.js versions.
brew install nvmClose and reopen your terminal, then install the latest LTS version of Node.js:
nvm install --lts4. Install Laravel Herd
Section titled “4. Install Laravel Herd”Laravel Herd is a macOS app that gives you a full PHP development environment.
- Go to herd.laravel.com
- Download and open the
.dmgfile - Drag Laravel Herd to your Applications folder
- Launch it
5. Install Visual Studio Code
Section titled “5. Install Visual Studio Code”brew install --cask visual-studio-codeOr download it from code.visualstudio.com.
Windows Setup
Section titled “Windows Setup”1. Install Git
Section titled “1. Install Git”Download from: https://git-scm.com/downloads
After installation, use Git in Git Bash, Command Prompt, or PowerShell.
2. Install NVM for Windows
Section titled “2. Install NVM for Windows”Download the latest nvm-setup.exe from:
https://github.com/coreybutler/nvm-windows/releases
Run the installer, then open a new Command Prompt and run:
nvm install ltsnvm use lts3. Install Laravel Herd for Windows
Section titled “3. Install Laravel Herd for Windows”Download from: https://herd.laravel.com/
- Run the
.exeinstaller - Follow the setup steps
- Launch Laravel Herd and set your local development folder
Laravel Herd includes PHP, Composer, and Laravel out of the box.
4. Install Visual Studio Code
Section titled “4. Install Visual Studio Code”Download from: https://code.visualstudio.com/
VS Code Settings
Section titled “VS Code Settings”Add these to your VS Code settings.json:
{ "editor.formatOnSave": true, "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, "emmet.includeLanguages": { "javascript": "javascriptreact" }, "editor.codeActionsOnSave": { "source.fixAll.eslint": true }}Recommended Extensions
Section titled “Recommended Extensions”- Tailwind CSS IntelliSense
- Prettier
- ESLint
- Auto Close Tag
- Code Spell Checker
- EditorConfig for VS Code
- ES7 React/Redux/GraphQL/React-Native Snippets
- GitLens
- Highlight Matching Tag
- Import Cost
- Live Share
- Version Lens
Configure Git
Section titled “Configure Git”1. Set Your Git Identity
Section titled “1. Set Your Git Identity”Run these in your terminal:
git config --global user.name "Your Name"git config --global user.email "your.email@example.com"Git uses these for every commit you make.
2. Generate an SSH Key
Section titled “2. Generate an SSH Key”This lets you authenticate with GitHub without typing your password every time.
ssh-keygen -t ed25519 -C "your.email@example.com"When prompted, press Enter to accept the default file path. Set a passphrase if you want.
3. Add the SSH Key to the SSH Agent
Section titled “3. Add the SSH Key to the SSH Agent”macOS/Linux:
eval "$(ssh-agent -s)"ssh-add ~/.ssh/id_ed25519Windows (Git Bash):
eval $(ssh-agent -s)ssh-add ~/.ssh/id_ed255194. Add the SSH Key to GitHub
Section titled “4. Add the SSH Key to GitHub”Copy your public key:
cat ~/.ssh/id_ed25519.pubThen:
- Go to GitHub SSH settings
- Click New SSH key
- Paste the key and give it a name (e.g.,
My Laptop) - Click Add SSH key
5. Test the Connection
Section titled “5. Test the Connection”ssh -T git@github.comYou should see:
Hi your-username! You've successfully authenticated...Install Discord
Section titled “Install Discord”We use Discord for team communication. Download it here.
Ask the Lucky Media PM for an invite to our server.
Optional Apps
Section titled “Optional Apps”Next Steps
Section titled “Next Steps”- Clone the repos you’ll be working on
- Install any project-specific dependencies
- Read through our coding standards and workflows
If anything breaks during setup, ask your team lead or a colleague.