Laktawan ang nilalaman
github · naka-sync
lahat ng proyekto

Portfolio TUI

Ang portfolio na ito bilang isang terminal app ay maaari mong buksan gamit ang SSH.

Ang artikulong ito ay isinalin gamit ang makina mula sa Ingles. Basahin ang orihinal

commits
44
nakaraang taon
mga bituin
0
wika
Go
huling pagtulak
Hul 2026
Sa pahinang ito
  1. Ano ito
  2. Patong-patong
  3. Ang mahirap na bahagi
  4. Katayuan
  5. README

Ano ito#

Isang terminal na bersyon ng portfolio na ito. Ito ay tumatakbo bilang isang full-screen TUI nang lokal, o bilang isang self-hostable SSH server na naaabot ng mga bisita gamit ang simpleng ssh . Alinman sa dalawa, magba-browse ka ng mga proyekto, post, kasanayan at karanasan gamit ang mga vim-style na key. Ang mga post sa blog ay nire-render mula sa Portable Text, na may talaan ng mga nilalaman sa t .

Patong-patong#

Gamitin ang Bubble Tea, Bubbles at Lip Gloss, at Wish para sa SSH server. Pareho ang nilalaman Sanity na binabasa nito gaya ng sa site na ito, kaya may isang lugar para i-edit, at babalik ito sa built-in na nilalaman kapag hindi maabot Sanity. Ang isang Docker image ay binubuo sa isang self-hosted GitHub Actions runner, at ang server ay bubuo ng sarili nitong host key sa unang pagsisimula.

Ang mahirap na bahagi#

Paglalagay ng rich text sa isang nakapirming grid. Ang mga talata, listahan, at mga code block ay kailangang i-wrap sa anumang lapad na iniuulat ng terminal ng kliyente, sa loob ng mga bordered pane, at ang mga listahan ay kailangang manatiling mahahanap. Para makapag-save ng row sa maliliit na terminal, ang mga breadcrumb ay iginuguhit papunta sa border ng pane sa halip na kumuha ng sarili nilang linya.

Katayuan#

Pinapanatili.

README.md

MeAshikeqbal/portfolio-tui · main

A terminal-native portfolio built with Go, Bubble Tea, Bubbles, and Lip Gloss. It can run locally as a full-screen TUI or as an SSH-accessible portfolio server powered by Wish.

Portfolio TUI demo

What it feels like

portfolio-tui opens with a short boot screen, then drops into a two-pane interface:

  • A left sidebar for navigation
  • A right content pane for Home, Projects, Skills, Experience, Education, Blogs, and Contact Me
  • Detail views for projects and blog posts
  • Searchable lists for projects and blogs
  • A full-screen help overlay and a table of contents overlay for blog posts

The Home screen is styled like a neofetch-style profile card and highlights your bio, skills, featured projects, and latest posts.

Features

  • Runs in two modes: local TUI and SSH server
  • Personalized branding from config.yaml
  • Sanity-backed content for projects, skills, posts, contact links, experience, and education
  • Graceful fallback content when Sanity is unavailable
  • Keyboard-first navigation with vim-style bindings
  • Search/filter support for project and blog lists
  • Blog detail pages with Portable Text rendering and t table of contents
  • Project detail pages with metadata, links, and technologies
  • Mouse wheel support for scrollable views
  • Docker and Docker Compose support for self-hosting

Quick Start

1. Clone and install dependencies

bash
git clone https://github.com/MeAshikeqbal/portfolio-tui
cd portfolio-tui
go mod download

2. Create your config

bash
cp config.example.yaml config.yaml

Then edit config.yaml with your name, role, bio, social links, ASCII logo, and SSH defaults.

If you want an interactive setup flow, you can also run:

bash
./setup-config.sh

More config details live in CONFIG.md.

3. Optional: create .env

Sanity and SSH runtime settings are loaded from environment variables. There is no .env.example in the repo right now, so create .env manually if you want to override the defaults:

code
SANITY_PROJECT_ID=your_project_id
SANITY_DATASET=production
SANITY_API_VERSION=2024-12-21

PORTFOLIO_SSH_HOST=0.0.0.0
PORTFOLIO_SSH_PORT=23234
PORTFOLIO_SSH_KEY=.ssh/term_key
PORTFOLIO_BIND_IP=0.0.0.0

Notes:

  • config.yaml controls your profile, branding, and default SSH settings
  • .env is mainly for Sanity access and runtime SSH overrides
  • if the SSH host key file does not exist, the app generates it automatically

4. Run locally

bash
go run .

Or build a binary:

bash
go build -o portfolio-tui
./portfolio-tui

5. Run as an SSH portfolio

bash
go run . serve

Or with the built binary:

bash
./portfolio-tui serve

Then connect from another terminal:

bash
ssh -p 23234 localhost

Navigation

Main sections

The live menu in the app is:

  1. Home
  2. Projects
  3. Skills
  4. Experience
  5. Education
  6. Blogs
  7. Contact Me
  8. Exit

Keybindings

Global
  • ? toggle help
  • q or Ctrl+C quit
Menu view
  • ↑ / k move up
  • ↓ / j move down
  • Enter open the selected section
  • H, P, S, E, D, B, C, X jump directly to a menu item
Content views
  • Esc go back
  • PgUp / b page up
  • PgDn / f page down
  • Home / g jump to top
  • End / G jump to bottom
List views
  • / filter projects or blog posts
  • Enter open the selected project or post
Blog detail
  • t open the table of contents overlay
  • 1-9 jump to a heading while the TOC is open

Content and Customization

The app reads portfolio identity and branding from config.yaml, and fetches live content from Sanity for:

  • project
  • skills
  • about
  • socialLink
  • post
  • experience
  • education

If Sanity is unavailable, the UI still boots and falls back to built-in placeholder content, which makes local development and demos much easier.

Docker

The container starts in SSH server mode by default. If you use the commands below as-is, create .env first or replace --env-file .env with explicit -e flags.

bash
docker build -t portfolio-tui .

docker run --rm -p 0.0.0.0:23234:23234 \
  --env-file .env \
  -v "$(pwd)/config.yaml:/app/config.yaml:ro" \
  portfolio-tui

Connect with:

bash
ssh -p 23234 localhost

Useful variants:

bash
# Persist generated SSH keys and logs
docker run --rm -p 23234:23234 \
  --env-file .env \
  -v "$(pwd)/config.yaml:/app/config.yaml:ro" \
  -v "$(pwd)/.ssh:/app/.ssh" \
  -v "$(pwd)/logs:/app/logs" \
  portfolio-tui

# Run local mode inside an interactive container
docker run --rm -it \
  --env-file .env \
  -v "$(pwd)/config.yaml:/app/config.yaml:ro" \
  portfolio-tui local

Docker Compose

compose.yaml runs the published GHCR image in SSH mode, mounts config.yaml, and stores SSH keys plus logs in Docker volumes. Compose also reads .env, so create that file before running these commands.

bash
docker compose pull
docker compose up -d
docker compose logs -f
docker compose down

Useful environment values:

code
PORTFOLIO_IMAGE=ghcr.io/meashikeqbal/portfolio-tui:latest
PORTFOLIO_SSH_PORT=23234
PORTFOLIO_BIND_IP=0.0.0.0

To inspect or remove persistent data:

bash
docker volume inspect portfolio-tui_portfolio_tui_ssh
docker volume inspect portfolio-tui_portfolio_tui_logs
docker compose down -v

Development

bash
go fmt ./...
go build .

Stack

  • Go
  • Bubble Tea
  • Bubbles
  • Lip Gloss
  • Wish
  • Sanity CMS
tingnan sa GitHub