Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ivankatliarchuk/dotfiles

☘️ Sensible hacker defaults for macOS
https://github.com/ivankatliarchuk/dotfiles

brew dotbot dotfiles dotfiles-macos iterm2 prezto zsh

Last synced: 5 days ago
JSON representation

☘️ Sensible hacker defaults for macOS

Awesome Lists containing this project

README

        

# CloudKat's dotfiles

Dotfiles setup

[![](https://github.com/ivankatliarchuk/dotfiles/workflows/release/badge.svg)](https://github.com/ivankatliarchuk/dotfiles/actions?query=workflow%3Arelease)
[![](https://img.shields.io/github/license/ivankatliarchuk/dotfiles)](https://github.com/ivankatliarchuk/dotfiles)
[![](https://img.shields.io/github/repo-size/ivankatliarchuk/dotfiles)](https://github.com/ivankatliarchuk/dotfiles)
![](https://img.shields.io/github/languages/top/ivankatliarchuk/dotfiles?color=green&logo=bash&logoColor=blue)
![](https://img.shields.io/github/commit-activity/m/ivankatliarchuk/dotfiles)
![](https://img.shields.io/github/last-commit/ivankatliarchuk/dotfiles)
![](https://img.shields.io/github/contributors/ivankatliarchuk/dotfiles)
[![GitHub forks](https://img.shields.io/github/forks/ivankatliarchuk/dotfiles.svg?style=social&label=Fork)](https://github.com/ivankatliarchuk/dotfiles)

**Table of Contents**

- [Project Structure](#project-structure)
- [Installation](#installation)
- [Caveats](#caveats)
- [Motivation](#motivation)
- [Dotbot Plugins](#dotbot-plugins)
- [🔖 Documentation](#-documentation)
- [Evaluate Tools](#evaluate-tools)
- [®️ Emojies](#-emojies)
- [#️⃣ TODO](#%EF%B8%8F%E2%83%A3-todo)
- [Awailable Commands](#awailable-commands)
- [📝 Guidelines](#-guidelines)
- [🔖 License](#-license)
- [How to Contribute](#how-to-contribute)
- [Authors](#authors)

## Project Structure

```
.
├── bin
├── brew
├── browser
│   ├── firefox
│   └── tor
├── git
│   ├── gitattributes
│   ├── gitcfg
│   ├── gitconfig
│   └── gitconfig.include
├── gnupg
├── iTerm
├── install.conf.yaml
├── locals
├── py
├── scripts
├── shell
├── tmux
├── tools
├── vendor
├── vim
└── zsh
├── LICENSE
├── Makefile
├── Vagrantfile
└── README.md
```

## Installation

**Warning:** If you want to give these dotfiles a try, you should first fork this repository, review the code, and remove things you don’t want or need. Don’t blindly use my settings unless you know what that entails. Use at your own risk!

## Caveats

These scripts are meant to run only on OS X

## Motivation

- [ThoughBot](https://github.com/thoughtbot/dotfiles)
- [Dotfiles](https://dotfiles.github.io/)
- [Dotfiles: awesome](https://project-awesome.org/webpro/awesome-dotfiles)

## Dotbot Plugins

## 🔖 Documentation

- [Bash Hacks](docs/bash-hints.md)
- [Tools and guides](docs/tools.md)

### Evaluate Tools

- [Cyberduck](https://cyberduck.io/)

### ®️ Emojies

- [Emoji: github](https://github.com/ikatyang/emoji-cheat-sheet)

## #️⃣ TODO

- ✅ ZSH (zsh-config)
- ✅ Tmuxp configuration (tmux-config) path = vendor/tmux-config
- ✅ Docker RMI alias
- ✅ Badges
- ✅ Github Hooks
- ✅ Move configs to own folders
- ✅ Install powerline fonts
- ✅ wgetrc & curlrc
- ✅ Pyenv correct setup
- ✅ Proper configre macup
- ✅ Tmux configs Setup/Document
- ✅ macOS setup [docs](tools/os/README.md)
- [X] Speed up shell
- [ ] POV [Yadm: dotfiles manager](https://formulae.brew.sh/formula/yadm)
- [ ] Firefox [auto config docs](tools/browser/firefox/readme.md)
- [ ] Hammersppoon config opensource [docs](tools/hammerspoon/readme.md)
- [ ] Chezmoi integration
- [ ] Support Linux/Debian
- [ ] [DNS Crypt](https://github.com/drduh/config/blob/master/dnscrypt-proxy.toml)
- [ ] Document github setup, blog it as well
- [ ] Dotbot templater plugin

## Awailable Commands

```
$ make help
Usage: make [target] [VARIABLE=value]
Targets:
install Install dotfiles without running shell
install-all Install all dotfiles
brew-install Install apps with Brew
osx-install Install macOSx
hooks Setup pre commit.
validate Validate files with pre-commit hooks
vm-up Run on Mac. Up
vm-dowm Run on Mac. Down
ignore-dirty Ignore dirty commits
install-deps Install dependencies
git-submodule Git submodules update
git-module-remove Remove submodule MODULE=something
open Open repository
```

### 📝 Guidelines

- 📝 Use a succinct title and description.
- 🦠 Bugs & feature requests can be be opened
- 📶 Support questions are better asked on [Stack Overflow](https://stackoverflow.com/)
- 😊 Be nice, civil and polite ([as always](http://contributor-covenant.org/version/1/4/)).

## 🔖 License

Copyright 2019 Ivan Katliarhcuk

MIT Licensed. See [LICENSE](./LICENSE) for full details.

## How to Contribute

Submit a pull request

## Authors

Currently maintained by [Ivan Katliarchuk](https://github.com/ivankatliarchuk) and these [awesome contributors](https://github.com/ivankatliarchuk/dotfiles/graphs/contributors).

[![ForTheBadge uses-git](http://ForTheBadge.com/images/badges/uses-git.svg)](https://GitHub.com/)