https://github.com/ruchernchong/dotfiles
macOS environment setup; compatible up to macOS Ventura (^13.0)
https://github.com/ruchernchong/dotfiles
dotfiles macos shell zsh
Last synced: 8 months ago
JSON representation
macOS environment setup; compatible up to macOS Ventura (^13.0)
- Host: GitHub
- URL: https://github.com/ruchernchong/dotfiles
- Owner: ruchernchong
- License: mit
- Created: 2017-06-05T13:32:59.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T08:48:23.000Z (9 months ago)
- Last Synced: 2025-04-05T10:06:36.376Z (8 months ago)
- Topics: dotfiles, macos, shell, zsh
- Language: Shell
- Homepage: https://github.com/ruchernchong/dotfiles
- Size: 1.85 MB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# dotfiles
This repository contains dotfiles and scripts that I use to customize my macOS/Linux development workflow. Feel free to use this as a reference for your own setup.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [OTA Installation](#ota-installation)
- [Manual Cloning](#cloning-the-repository)
- [System Requirements](#system-requirements)
- [Configurations](#configurations)
- [Feedback](#feedback)
- [License](#license)
## Features
- Installs Oh-My-Zsh by default
- Comprehensive git aliases for daily use
- Customized oh-my-zsh settings
- [Automated setup script](setup.sh)
## System Requirements
### Supported Platforms
- macOS (10.15+)
- Linux (Ubuntu 20.04+, Fedora 33+)
### Prerequisites
- Zsh
- Git
- Homebrew (macOS)
- curl
## Configurations
### Zsh Customizations
- Custom Oh-My-Zsh theme configuration
- Key plugins:
- zsh-autosuggestions
- zsh-syntax-highlighting
- git
- docker
### Git Aliases
- `g` → `git`
- `gp` → `git pull`
- `gps` → `git push`
- Custom commit and branch management shortcuts
## Installation
**Warning:** Do not blindly use these settings as they may override or modify your existing configuration. It is highly recommended to clone/fork this repository to another folder. Use at your own risk!
### OTA Installation
```zsh
curl -L https://raw.githubusercontent.com/ruchernchong/dotfiles/master/install.sh | bash
```
### Cloning the Repository
```zsh
git clone https://github.com/ruchernchong/dotfiles.git $HOME/dotfiles
cd $HOME/dotfiles
chmod a+x setup.sh
source setup.sh
# Set up Git Hooks
git config core.hooksPath .githooks
chmod +x .githooks/post-push
```
### Git Hooks Setup
This repository includes a post-push hook for automatically updating and committing the Brewfile:
- Located in `.githooks/post-push`
- Automatically runs `brew bundle dump`
- Stages and commits Brewfile changes
- Requires manual activation after cloning
To enable the hook:
```zsh
git config core.hooksPath .githooks
chmod +x .githooks/post-push
```
## Feedback
I welcome any feedback or suggestions by creating an [issue](https://github.com/ruchernchong/dotfiles/issues) or a [pull request](https://github.com/ruchernchong/dotfiles/pulls).
## License
This code is available under the [MIT License](LICENSE)