Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/martijngastkemper/dotfiles


https://github.com/martijngastkemper/dotfiles

dotfiles git homebrew iterm2 macos tmux vim zsh

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# Dotfiles



[![Github Action test installation badge](https://github.com/martijngastkemper/dotfiles/workflows/Test%20installation/badge.svg)](https://github.com/martijngastkemper/dotfiles/actions) [![Github Action linting badge](https://github.com/martijngastkemper/dotfiles/workflows/Linting/badge.svg)](https://github.com/martijngastkemper/dotfiles/actions)



![Screenshot of my terminal](screenshot.png)



Inspired by [harmenjanssen/dotfiles](https://github.com/harmenjanssen/dotfiles), [jackfranklin/dotfiles](https://github.com/jackfranklin/dotfiles) and [mathiasbynens/dotfiles](https://github.com/mathiasbynens/dotfiles)



## Utility scripts



### `make`



Lists all the available source. For a fine grained install.



### `bin/apply_git_templates`



After changing a hook in `git_templates/` I want to apply these changes to existings checkouts. This scripts copies the files to `.git/` in the project. It asks to confirm overwriting existing files.



### `bin/dark`



Which tmux and vim to dark mode.



### `bin/light`



Which tmux and vim to light mode.



### `bin/public_port`



When using Docker Compose it's not clear which public ports services expose. Looking into one of the `docker-compose*.yml` files is cumbersome. Use `public_port` to get the public port of a service.



Uses port 80 by default



    $ public_port

    Private port 80

    web: 0.0.0.0:10000



Get the port for MySQL



    $ public_port 3306

    Private port 3306

    db: 0.0.0.0:20000



## Installation



### Step 1: Dotfiles



    $ git clone [email protected]/martijngastkemper/dotfiles.git ~/.dotfiles

    $ # when git is not available install brew (brew.sh), this will install git on MacOS

    $ cd ~/.dotfiles

    $ make symlinks



### Step 2: Brew



Follow the installation instructions on [brew.sh](https://brew.sh).



    $ make install_brew_packages



### Step 3: Shell



Zsh will be installed by Brew. To activate it run:



    $ make configure_zsh



When Zsh is not available but Bash is:



    $ make configure_bash



### Step 4: vim



    $ make configure_vim



### Step 5: tmux



Start tmux before configuring it.



    $ tmux new-session -d

    $ make configure_tmux



### Step 6: Node



    $ make install_nvm

    $ nvm install 20

    $ make install_yarn



### Step 7: Composer



Install Composer 2* globally:



    $ make install_composer



A mechanism to more effectively merge `composer.json` and `composer.lock` files. The Git configuration requires this packages if it has to merge one of the files.



    $ make install_composer_git_merge_driver



* Switch between Composer versions with `composer1` and `composer2`.



### Step 8: Configure MacOS



    $ make configure_macos



Settings to change manually



*Let Caps Lock be an Escape key*

System Preferences -> Keyboard -> Modifier Keys -> Caps Lock -> Esc



*Lock computer immediately*

System Preferences -> Security & Privacy -> General -> Require password ...



Add a cronjob to switch between light and dark mode automatically based on the mode MacOS has selected.



    $ crontab -l > tmp_crontab

    $ echo "* * * * * sh ~/.dotfiles/macos_switch_theme.sh > /tmp/stdout.cron.log 2> /tmp/stderr.cron.log" >> tmp_crontab

    $ crontab tmp_crontab

    $ rm tmp_crontab



### Step 9: GPG



Prevent "unsafe persmissions on homedir" error:



```

chmod 700 ~/.dotfiles/gnupg

```



Get the GPG keys from 1Password and import them:



```

gpg --import /location/of/the/gpg/key.file

```



## Override Zsh settings



To load settings to Zsh which aren't global add them to:



    $ vim ~/.zshrc.local



## PhpStorm



My PhpStorm settings are stored in a private repo.



The plugins I use:



- .env files support

- IdeaVim

- Makefile support

- Prettier

- Terraform and HCL



## Find domain and key for usage in ``defaults``



It's hard to find the right domaian and key of a preference. To find it use ``diff``



    $ defaults read > before

    # make the desired changes to your preferences

    $ defaults read > after

    $ diff before after