Skip to content

zenjoy/dotfiles

Repository files navigation

Zenjoy's Dotfiles

Requirements

macOS

TL;DR: Get XCode + Command Line Tools

You can get Xcode from the Mac App Store. You’ll need at least version 4.4 of Xcode for it to work with OS X Mountain Lion. After the installation, open up Xcode in your /Applications folder. You’d want to go to Xcode -> Preferences -> Downloads tab then install the “Command Line Tools.” Or run xcode-select --install in the terminal. After you’re done, quit Xcode and fire up Terminal.

If you're on catalina or above, give the terminal program you're using 'Full Disk Access' before starting the installation.

We use iTerm2 and Visual Studio Code.

Windows

TL;DR: Get Windows Subsystem for Linux (WSL) + Ubuntu + Visual Studio Code

The steps to get started on Windows are following:

  1. Open PowerShell as Administrator and run:

    Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
    
  2. Restart your computer when prompted.

  3. Install Ubuntu from the Windows Store. Run it once and choose a username and password different from 'root'. Choose the password wisely and remember it.

  4. Install Visual Studio Code before proceeding with the dotfiles installation.

  5. Install the FiraCode Font from https://nerdfonts.com/

  6. Install WSLTTY and set it up as default shell in VS Code (CTRL+shift+P » Terminal: Select Default Shell). For best esthetics, open it and use following settings (Click on Menu Icon » Options):

    • Under looks use the Theme: dracula
    • Under Text choose FuraCode NF as font, choose the font size as desired
    • Under Terminal, change Type xterm to xterm-256color
  7. Open WSLTTY and proceed with the installation.

Install

To install, run:

sh -c "$(curl -fsSL https://raw.githubusercontent.com/zenjoy/dotfiles/master/install.sh)"

Or manually:

git clone https://github.com/zenjoy/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
./script/bootstrap

This will symlink the appropriate files in .dotfiles to your home directory. Everything is configured and tweaked within ~/.dotfiles.

The only file you'll want to change or create is ~/.localrc, where you can put personal changes, preferences or secrets.

Setup Scripts

There are multiple setup scripts, that can be run multiple times to check if you are running the latest version or to install new additions to the dotfiles.

Run following commands from anywhere to install:

  • update-dotfiles: update your local copy of this repository
  • update-all: update your local copy of this repository AND check if everything is nicely installed
  • setup-dotfiles: ensure the minimal setup is done to properly work with these dotfile
  • setup-osx: setup macOS sane defaults and multiple useful apps
  • setup-dev: setup all requirements to get started for (web|mobile|backend|k8s) development
  • setup-cli-apps: install several useful, convenient or just fun command line tools
  • setup-git: setup git and related utilities
  • setup-vscode: setup Visual Studio Code, most useful extensions and several nice themes

Tips

Credits & Thanks

This repo is a fork: a huge thanks and all credit goes to @holman for his view on organizing dotfiles