Skip to content

ryu-ryuk/porterm

Repository files navigation

Porterm Logo
porterm

A Catppuccin-themed, interactive terminal portfolio and resume viewer.

Install with curl (Catppuccin Green)

porterm is a Catppuccin-themed, interactive terminal portfolio and resume viewer.
Built with Go, styled with Catppuccin Mocha, and powered by Bubble Tea, Glamour, and Lipgloss.


Preview

Preview of porterm


Quick Install / One-time run

curl -sL https://scripts.alokranjan.me/porterm.sh | bash

SSH

ssh porterm.alokranjan.me

Overview

porterm (PORTfolio + TERMinal) is a modern, Catppuccin-themed terminal portfolio and resume viewer.
It features animated banners, a dynamic About section, clickable project links, markdown resume rendering, and a clean, centered UI—built for developers who want to flex on others ;)


Features

  • Catppuccin Mocha Theme: I love it :)
  • Animated ASCII Banners: Custom banner animations and glitch effects.
  • Centered Responsive Layout: UI is always centered, adapting to any terminal size.
  • Dynamic About Section: Rotating fun facts, skills, and passions.
  • Project Showcase: Clickable project links with markdown descriptions.
  • Resume Viewer: Scrollable, zoomable, and beautifully rendered markdown resume.
  • Badges & Webrings: Show off your achievements and affiliations/webrings.
  • Keyboard Navigation: Navigate sections with numeric keys.
  • Modern Stack: Built with Bubble Tea, Lipgloss, and Glamour.

Getting Started

Prerequisites

  • Go 1.22 or later
  • A terminal emulator with OSC-8 hyperlink support recommended

Installation

git clone https://github.com/ryu-ryuk/porterm.git
cd porterm
go build

Run

go run .

Usage

  • 1 — About Me (dynamic facts, skills, passions)
  • 2 — My Works (clickable project links)
  • 3 — Resume (scrollable, zoomable, markdown)
  • 4 — Webrings & Badges
  • q — Quit
  • Esc - Back
  • Arrow keys / PgUp / PgDn — Scroll in resume

Theming

All colors are from the Catppuccin Mocha palette.
You can adapt the theme by editing assets/glamour-catppuccin.json and the color constants in styles/theme.go.

PS. I have hardcoded some colors here & there ;>


Customization

  • Resume: Place your markdown resume in internal/data/content/resume.md.
  • Projects: Edit internal/data/assets/paste.txt for your project list.
  • Badges & Webrings: Update views/badges.go as needed.
  • Banner and vector art: Customize in model.go.

Architecture

  • Bubble Tea — State management, event loop, and UI structure
  • Lipgloss — Layout, color, and style primitives
  • Glamour — Markdown rendering with custom styles

Credits


This project is designed for developers who only care about terminal aesthetics.