Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/samueldosramos/dotfiles

macOS Dotfiles - Easily configure macOS
https://github.com/samueldosramos/dotfiles

bash brew cask dotfiles macos oh-my-zsh terminal zsh

Last synced: 4 days ago
JSON representation

macOS Dotfiles - Easily configure macOS

Awesome Lists containing this project

README 

        
# macOS Dotfiles



This is a simple and flexible dotfiles and scripts to setup _macOS_.



## Table of Contents



1. [What are dotfiles][]

1. [Features][]

1. [Installation][]

1. [Manual setup][]

1. [Resources][]



## What are dotfiles



Dotfiles are configuration files on Unix-based systems. At first they are just hidden configuration files of the system (that's why the reason for starting with `.`). However, we can use them to make it easier to configure our computers, with many advantages:



- Easy to format a new computer

- Automation of tasks

- Easy maintenance

- Storage in remote locations (GitHub, iCloud, Dropbox, etc)

- Versioning

- Import to multiple computers

- Customize the terminal



## Features



_Check linked files to more details._



### Installation files



- [apps.sh][] - installs _Homebrew_, _Homebrew Cask Upgrade_ and some _apps_.

- [dock.sh][] - macOS Dock items customization.

- [dotfiles.sh][] - installs _Oh My Zsh_, _.zshrc_ and _Git_ configs.

- [hostname.sh][] - change _hostname_ (MacBook name).

- [macos.sh][] - macOS defaults configs.

- [npm.sh][] - install _npm_ packages.

- [setup.sh][] - main installer.

- [ssh.sh][] - generate _SSH_.

- [user.sh][] - user data to configuration of _Git_ and _SSH_.

- [util.sh][] - support functions for other installers.



**Note:** _These files will be discarded later._



### Settings Files



- [.gitignore_global][] - global _gitignore_.

- [.zshrc_intel][] - terminal configs with aliases, paths, plugins and theme for Macs with _Intel_.

- [.zshrc_silicon][] - terminal configs with aliases, paths, plugins and theme for Macs with _Apple Silicon_.

- [starship.toml][] - [Starship][] theme settings.



**Note:** _These files are permanent_.



## Installation



```bash

git clone https://github.com/samuelramox/dotfiles.git && cd dotfiles



./setup.sh

```



**Note:** You can also download a specific [release][].



### Explaining the process



The [setup.sh][] process will open [user.sh][] for you to add your user data. This data is necessary for the configuration and functioning of Git and SSH.



```bash

# - GIT_NAME: name and surname to use in Git settings.

# - GIT_EMAIL: email to use in Git settings.

# - SSH_EMAIL: email to use in SSH settings.

# - HOSTNAME: hostname/computer name (optional, leave empty if you don't want to change).

```



It will then install the following scripts, in this order:



- [apps.sh][] - install _Homebrew_, _Homebrew Cask Upgrade_ and applications.



  - Install [Homebrew][].

  - Homebrew formulas: [curl][], [Git][], [Nano][], [Node][], [PostgreSQL][], [Python][], [Ruby][], [Tree][], [Yarn][], [Zsh][].

  - Homebrew taps: [homebrew/fonts][], [homebrew/drivers][], [homebrew/versions][], [homebrew/command-not-found][].

  - Homebrew casks: [Google Chrome][], [IINA][], [JetBrains Mono][] and [Visual Studio Code][].

  - Install [Homebrew Cask Upgrade][].



- [dotfiles.sh][] - install [Oh My Zsh][], some Zsh plugins, [asdf][], [Starship][] theme and set **.gitconfig**.

- [npm.sh][] - install some npm packages.

- [macos.sh][] - set custom macOS preferences.

- [dock.sh][] - install [dockutil][] and set custom permanent apps in Dock. _Finder_ and _Recycle Bin_ are already permanent (unless you change this).

- [ssh.sh][] - Generate _SSH_.

- [hostname.sh][] - Update _hostname_ (MacBook name).

- Create a directory called _Developer_ in _Home_ directory for projects and development.

- Cleanup cached downloads and remove the installation zip and folder.



**Note:** I suggest you read these files and turn your preferences on/off before installation.



## Manual setup



[Visual Studio Code][] settings are loaded by the [Settings Sync][], so you will have to change manually or load your settings.



### Visual Studio Code - Config



`Code → Preference → Settings (or CMD + ,) and add or edit the following values:`



```json

"editor.fontFamily": "JetBrains Mono",

"editor.fontLigatures": true,

```



## Resources



- [Dotfiles Repositories][]

- [Awesome Dotfiles][]

- [Homebrew][]

- [Homebrew Cask Upgrade][]

- [Dockutil][]

- [Sensible macOS defaults][]

- [Awesome OSX Command Line][]

- [Oh My Zsh][]

- [Starship][]



[.gitignore_global]: configs/gitignore_global

[.zshrc_intel]: configs/.zshrc_intel

[.zshrc_silicon]: configs/.zshrc_silicon

[apps.sh]: scripts/apps.sh

[asdf]: https://asdf-vm.com

[awesome dotfiles]: https://github.com/webpro/awesome-dotfiles

[awesome osx command line]: https://github.com/herrbischoff/awesome-osx-command-line

[curl]: https://curl.haxx.se

[dock.sh]: scripts/dock.sh

[dockutil]: https://github.com/kcrawford/dockutil

[dotfiles.sh]: scripts/dotfiles.sh

[dotfiles repositories]: https://dotfiles.github.io/

[features]: #features

[git]: https://git-scm.com

[google chrome]: https://www.google.com/chrome/

[homebrew]: https://brew.sh/

[homebrew cask upgrade]: https://github.com/buo/homebrew-cask-upgrade

[homebrew/command-not-found]: https://github.com/Homebrew/homebrew-command-not-found

[homebrew/drivers]: https://github.com/Homebrew/homebrew-cask-drivers

[homebrew/fonts]: https://github.com/Homebrew/homebrew-cask-fonts

[homebrew/versions]: https://github.com/Homebrew/homebrew-cask-versions

[hostname.sh]: scripts/hostname.sh

[iina]: https://iina.io/

[installation]: #installation

[jetbrains mono]: https://jetbrains.com/mono

[macos.sh]: scripts/macos.sh

[manual setup]: #manual-setup

[nano]: https://www.nano-editor.org

[node]: https://nodejs.org/

[npm.sh]: scripts/npm.sh

[oh my zsh]: https://ohmyz.sh

[postgresql]: https://www.postgresql.org

[python]: https://www.python.org

[release]: https://github.com/samuelramox/dotfiles/releases

[resources]: #resources

[ruby]: https://www.ruby-lang.org/

[sensible macos defaults]: https://github.com/mathiasbynens/dotfiles/blob/master/.macos

[settings sync]: https://code.visualstudio.com/docs/editor/settings-sync

[setup.sh]: scripts/setup.sh

[starship]: https://starship.rs

[starship.toml]: configs/starship.toml

[ssh.sh]: scripts/ssh.sh

[tree]: http://mama.indstate.edu/users/ice/tree/

[user.sh]: scripts/user.sh

[util.sh]: scripts/util.sh

[visual studio code]: https://code.visualstudio.com

[what are dotfiles]: #what-are-dotfiles

[yarn]: https://yarnpkg.com/

[zsh]: https://www.zsh.org