Dev Setup

A shell-agnostic development environment setup system for macOS.

Overview

Setting up a new developer machine can be an ad-hoc, manual, and time-consuming process. This dev-setup repository aims to simplify the process with easy-to-understand instructions and shell-agnostic scripts to automate the setup of your development environment.

The key features of this setup system include:

• Shell agnostic - supports bash, zsh, and fish shells
• Modular design - install only what you need
• Interactive setup - guided installation with prompts
• macOS optimized - includes sensible macOS defaults for developers
• Modern tools - focuses on current development tools and practices

What's Included

This setup system can configure the following components:

• Shell Environment: Choose between bash, zsh, or fish with optimized configurations
• Core Development Tools: Vim, tmux, git, and other essential command-line utilities
• Programming Languages: Python, Node.js, Go, Rust
• Python Development: pipx, poetry, pdm, uv, Django, Flask, FastAPI, Jupyter
• Web Development: Node.js ecosystem, TypeScript, React, Vue, Angular, testing tools
• Data Stores: MySQL, PostgreSQL, MongoDB, Redis, and Elasticsearch
• macOS Defaults: Developer-friendly system preferences and settings
• GUI Applications: VS Code, iTerm2, Docker, and more

Installation

Prerequisites

• A macOS system
• Administrator (sudo) access
• Internet connection

Quick Start

1. Clone this repository:

   git clone https://github.com/dave6892/dev-setup.git
   cd dev-setup

2. Make the scripts executable:

   chmod +x chmod.sh
   ./chmod.sh

3. (Optional but recommended) Update macOS and install Xcode Command Line Tools:

   ./system-update.sh

4. Run the setup script:

   ./setup.sh

5. Follow the interactive prompts to customize your installation.

Running Individual Components

If you only want to install or configure specific components, you can use the Makefile:

# Show available components
make help

# Install only Homebrew packages
make brew

# Install only Python tools
make python

# Install only web development tools
make web

# Install only database systems
make datastores

# Configure specific shells
make bash
make zsh
make fish

# Apply only macOS defaults
make macos

Directory Structure

dev-setup/
├── Makefile                    # Build automation and task runner
├── setup.sh                    # Main interactive setup script
├── system-update.sh            # Update macOS and install Xcode tools
├── macos-defaults.sh           # macOS system preferences configuration
├── chmod.sh                    # Make all scripts executable
├── common/                     # Common installation scripts
│   ├── utils.sh                # Shared utility functions and colors
│   ├── brew-common.sh          # Common Homebrew installations
│   ├── python-common.sh        # Python development tools
│   ├── web-common.sh           # Web/JavaScript development tools
│   └── datastores-common.sh    # Database installations
└── shells/                     # Shell-specific configurations
    ├── bash-setup.sh           # Bash shell setup and configuration
    ├── zsh-setup.sh            # Zsh shell setup and configuration
    └── fish-setup.sh           # Fish shell setup and configuration

Customization

Adding Your Own Configurations

You can add your own personal configurations by creating a local configuration file:

• For bash: ~/.bashrc.local
• For zsh: ~/.zshrc.local
• For fish: ~/.config/fish/config-local.fish

These files will be loaded automatically but won't be overwritten by future updates.

Modifying Default Installations

If you want to change what gets installed by default:

1. Edit the corresponding script in the common/ directory
2. For shell-specific customizations, edit the scripts in the shells/ directory

Usage Tips

• To update your development environment later, simply run ./setup.sh or make all again
• Run make help to see all available commands
• Use reload alias to refresh your shell configuration after making changes
• If you're switching between shells frequently, you might want to keep your configurations synchronized

Troubleshooting

If you encounter issues during setup:

1. Check that you have administrator permissions
2. Ensure Homebrew is installed correctly
3. Make sure your internet connection is stable
4. Try running individual modules manually
5. Check the shell-specific log files in your home directory

For specific issues, please open an issue on GitHub.

Extending

To extend this setup for your own needs:

1. Fork this repository
2. Add or modify scripts in the common/ or shells/ directories
3. Update the main setup.sh script to include your new modules

Credits

This project was inspired by and adapted from donnemartin/dev-setup.

License

This repository is licensed under the Apache License 2.0 - see the LICENSE file for details.

Contact

Feel free to contact me to discuss any issues, questions, or comments.

My contact info can be found on my GitHub page.