Skip to content

brdgcn/eazy-onboard

 
 

Repository files navigation

Eazy Onboard

Synopsis

This script is created to simplify the onboarding experience for a new engineer on a MacOS device (devops focused!)

Rationale

As a new hire, onboarding typically takes hours or even days because of the following:

  • Find and locate (correct) onboarding docs
  • Download software
  • Clone repos
  • Get application access

Using this script, it will download software and clone some repos in just a few minutes. 😊

Prerequisite

  • This is for MacOS only. Sorry Windows and Linux users 😞

How to Run

Simply run make run. As the script runs, part of the setups will prompt you to enter things like username, passwords, etc.

What Does it Actually Do?

The script would do the following, in this order (if they don't already exist):

  1. generate an ssh keypair and instruct you to upload the public key to Github
  2. install homebrew
  3. install a number of apps via homebrew (for a full list, see onboarding-inventory)
  4. install a few VS Code extensions (for a full list, see onboarding-inventory)
  5. install oh_my_zsh and awesome vim
  6. install Docker for Mac (MacOS Security may block the initial start. Instructions provided on how to resolve it in Systems Preferences) and config it
  7. configure git to resolve some common errors
  8. configure terraform to use the correct version
  9. install kubectl aliases from kubectl-aliases
  10. add even more aliases

How to Contribute

  • We realize that the goodies here may not be for everyone. In eazy-onboard.sh, you may add another elif statement to include your own functions only
  • Feel free to add or remove items from the lists of apps, VS Code extensions, and team repos in onboarding-inventory)
  • Please add unit tests if possible to test-eazy-onboard.sh, then run make test. More unit tests will be added over time
  • Add your feature to this readme

Contributors

Gary Cheung

About

easily install useful software to Mac

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Shell 98.9%
  • Makefile 1.1%