Skip to content

Latest commit

 

History

History
139 lines (90 loc) · 3.29 KB

README.md

File metadata and controls

139 lines (90 loc) · 3.29 KB
Raw

Woohoo Labs. Phoenix

Software License Gitter

Woohoo Labs. Phoenix is a simple configuration management tool for your development environment.

Table of Contents

Introduction

Woohoo Labs. Phoenix helps you set up and installing your development environment whatever platform you use.

Install

You have to clone the project first in order to install it:

git clone git@github.com:woohoolabs/phoenix.git

Then you have to create the configuration files by running the following commands:

# Create the main configuration file
cp config/config.sh.dist config/config.sh

# Create Bash configuration
cp config/bash/.bash_profile.dist config/bash/.bash_profile

# Create Git configuration
cp config/git/.gitconfig.dist config/git/.gitconfig

# Create GPG configuration
cp config/gpg/gpg.conf.dist config/gpg/gpg.conf

# Create SSH configuration
cp config/ssh/config.dist config/ssh/config

# Create ZSH configuration
cp config/zsh/.zshrc.dist config/zsh/.zshrc

# Create Warp configuration
cp config/zsh/.warprc.dist config/zsh/.warprc

Usage

First, you should customize config/config.sh. Then you can install the necessary dependencies:

./woohoo install

Afterwards, you should manually:

  • run Docker Desktop
  • set the iTerm2 color preset according to your preference (e.g. "Solarized Dark")
  • set the console font in iTerm2 and JetBrains IDE-s to "SourceCodeProPowerlineAwesomeRegular"

Now, you should deploy the necessary configuration. In order to do so, first customize config/zsh/.zshrc, config/git/.gitconfig, and config/zsh/.warprc. Then run the following command:

./woohoo config

Afterwards, you can import your SSH and GPG configuration (if you don't have one yet, then you should rather generate new keys).

cp config/ssh/id_rsa.sh.dist config/ssh/id_rsa.sh
# Fill in the $SSH_PUBLIC_KEY and $SSH_PRIVATE_KEY variables
./woohoo ssh import id_rsa

Then

# Create a file with FILE_NAME containing your GPG key
./woohoo gpg import {FILE_NAME}

Features

The woohoo command provides several subcommands:

install

verify

config

ssh

gpg

You can refer to the woohoo help command for the current list of supported operations.

Versioning

This library follows SemVer v2.0.0.

Change Log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Support

Please see SUPPORT for details.

Credits

License

The MIT License (MIT). Please see the License File for more information.