Skip to content

ChangeHow/suitup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

25 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Suit up!

About name

This name is inspired by Barney's catchphrase, Barney is a character in my favorite TV series: How I met your mother.

About this repository

This repository contains my personal development configurations like zsh, shell scripts... ๐Ÿ™Œ very welcome to try it out~

Easy to get started

I don't know how to use single one script to install everything, so I seperate them into different scripts.

Please follow the steps below to init your development environment:

  1. Clone this repository to your local machine.
  2. Before running the scripts and if you living in China mainland, please ensure you can visit google and github at least.
  3. Run sh ./bootstrap.sh to install homebrew, zsh and oh-my-zsh.
  4. Run sh ./scripts/init/command-line-tools.sh to install CLIs that I suggest. They are:
    • autojump, a tool to jump to your favorite directory, it supports fuzzy matching.
    • bat, a cat clone with syntax highlight.
    • htop, to monitor your system.
    • neofetch, to insignt your system information.
    • postman, sorry, it's not a CLI, but I still install it in this step. :sad
    • exa, a ls clone with syntax highlight.
    • atuin, a tool to power your shell history.
  5. Run sh ./scripts/init/install-zsh-plugins.sh to init zplug and add plugins to it. There are the plugins:
    • zsh-autosuggestions, to suggest commands when you type.
    • zsh-syntax-highlighting, to highlight commands when you type.
  6. Okay, as a frontend developer, I create a script to init the development environment. They are:
    • volta, a tool to manage node versions. And I will open VOLTA_FEATURE_PNPM to enable auto switching for pnpm(volta-cli/volta#737 (comment))
      • node and pnpm, installed them by volta.
      • some tools like eslint, prettier, stylelint...
    • commitzen, a tool to help you write commit message.
  7. Actually, those tools seems enough to start developping. But I still have some customize configrations, you can keep following the steps if you want.

Customize configurations

Apps

sh ./scripts/init/apps.sh

Running this script to install useful apps like:

  • google chrome
  • visual studio code
  • iterm2
  • raycast, alternative to alfred, a powerful tool to help you improve your productivity.
  • orbstack, a tool to manage your docker containers.
  • itsycal, a tool to show your calendar.

My dot files

You can init .vimrc by running:

sh ./scripts/dev/vim-config.sh

You can edit it in ~/.vimrc

And add some useful zsh aliases by running:

sh ./scripts/dev/zsh-alias.sh

You can edit it in ~/.config/suitup/aliases

Other sources

In /sources, there are some sources you can use.

Setup iTerm

You can import Best!.json to setup the color schema for iTerm2 - macOS Terminal Replacement.

OMZ theme

if you don't want pay much time in theme, you can use romkatv/powerlevel10k: A Zsh theme.

or you can install p10k by zplug:

  1. run this command to add p10k to plugin
    echo "zplug romkatv/powerlevel10k, as:theme, depth:1" >> ~/.config/suitup/plugins
  2. run reload-zsh to reload zsh config if you have run sh ./scripts/dev/zsh-alias.sh before.

Font

cascadia is a nerd font for romkatv/powerlevel10k: A Zsh theme.

How to reset/reinstall

Run this command and reset to default zsh config(.zshrc)

sh ./clean.sh

This script will do:

  1. remove ~/.config/suitup
  2. remove ~/.oh-my-zsh
  3. remove ~/.zshrc
  4. switch to bash, or you can keep zsh if you macOS has changed the default shell to zsh.

In the end

After doing this, you can enjoy your development journey. ๐ŸŽ‰

About

this repositery contains my personal development configurations like zsh, shell scripts... ๐Ÿ™Œ very welcome to try it out~

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages