arsam
v3.0.1
Published
Arsam Sarabi's portfolio in an interactive terminal app - A modern, type-safe CLI built with TypeScript
Downloads
624
Maintainers
Readme
Arsam's résumé in the terminal 🤷🏻♂️
What is this?
This is a modern, type-safe command line tool that displays my résumé in an interactive terminal interface. Built with TypeScript and following clean architecture principles.
Features
- 🎨 Beautiful terminal UI with animations
- 📦 Modern ESM architecture
- 🔒 Strict type safety with TypeScript
- 🏗️ Clean, layered architecture
- ⚡ Fast builds with Bun
- 🧪 Highly testable and maintainable
- 🎯 Single responsibility principle throughout
Usage
Run with npx (recommended)
npx arsamInstall globally
npm install -g arsam
# or
bun install -g arsamDevelopment
Prerequisites
- Bun >= 1.0.0
Setup
# Install dependencies
bun install
# Run in development mode
bun dev
# Build the project
bun run build
# Run the built version
bun startScripts
bun dev- Run the application in development modebun run build- Build for productionbun start- Run the production buildbun run typecheck- Run TypeScript type checkingbun run lint- Lint the codebasebun run prettier- Format code with Prettierbun run tidy- Run both linting and formatting
Architecture
This project follows modern software architecture principles with clear separation of concerns:
- Config Layer: Centralized configuration and constants
- Core Layer: Business logic and domain services
- UI Layer: Presentation and user interaction
- Data Layer: Data models and content
Technical Stack
- TypeScript 5.3+: Modern, strict type safety
- Bun: Fast runtime, package manager, and bundler
- ESM: Native ES modules
- @oakoliver/lipgloss: Error styling (Charm Lip Gloss port)
- boxen: Bordered content boxes (emoji-safe width)
- inquirer: Interactive CLI prompts
- figlet: ASCII art text
License
MIT
