KCC Development Environment

Last updated on 11/29/2022

Documentation on setting up the development environment needed for KCC's redesign projects.

---

Overview

Our projects use Ruby and Node.js to build static HTML sites, and compile assets. The documents in this repo will guide you through setting up the development environment currently used by KCC.

---

Prerequisites

• Mac OS X Prerequisites
  • Mac OS X Version
  • Xcode
  • Install Xcode Command Line Tools
• Windows Prerequisites
• Linux Prerequisites

---

Version Management

We use RVM and NVM to manage versions of Ruby and Node (respectively.)

• Ruby Version Manager (RVM)
  • RVM Prerequisites
    • Install Homebrew
    • Install GPG via Homebrew
  • Installing RVM
    • Get the GPG Keys
    • Run the Install Script
  • Install ruby-2.6.3
  • Set the Default ruby version

• Node Version Manager (NVM)
  • NVM install script
    • Verify Installation
  • Add Bash Function
    • Install cowsay via Homebrew

---

Installing & Building a Project

• Installing and Building a Project
  • Clone the Project
  • Install Dependencies
  • Running a Build
    • Production Build
    • Development Build
  • Update Browserslist caniuse Database

---

Setting Up Dotfiles

• Setting up Dotfiles
  • Load Custom Dotfiles in .bash_profile
  • .functions
  • .aliases
    • Folder Navigation
    • Git
    • Other

---

Publishing Branch Workflow

• Publishing Branch Workflow
  • Creating a publish branch
  • Developing locally

---

Archived Content

Archived content is documentation that is either outdated or no longer relevant.

Setting Up & Using RVM & NVM

• Setup RVM
• Updating Ruby Versions
• Setup NVM
• Updating Nodejs & npm Versions

Install Jekyll

• Install Jekyll
• Install the kcc-gem-theme

---