How shubhexists/terminal-portfolio works
Project type and purpose
• This is a single-page front-end application built with ReactJS and TailwindCSS.
• It serves as a terminal-style portfolio template, displaying information (resume, links) in a command-line interface style.
File structure
Top-level directories and files:
• public/ – contains static assets (index.html, manifest.json, robots.txt, resume.pdf, preview image)
• src/ – React source code, organized into components and utility modules
• .github/workflows/node.js.yml – CI pipeline for installing, testing, building
• tailwind.config.js, post-install configs, tsconfig.json – build and type settings
Key patterns:
• A clear separation between static assets (public) and React application (src).
• Components in src/components implement the UI (header, terminal view, command input area).
• Utils in src/utils handle command definitions and keyboard bindings.
README for additional insights
• Confirms it’s a TailwindCSS + ReactJS portfolio template.
• No mention of a backend or external API—app is purely client-side, consuming only its own static assets.
Main components
4.a. Frontend Client (Browser)
– React Application (App.tsx)
• Header Component
• Terminal Component (renders command output)
• Command-Area Component (accepts user input)
• Utilities: commands.tsx, keybindings.tsx
– Styling Engine (TailwindCSS)
4.b. Static Asset Server / CDN (e.g., GitHub Pages, Netlify)
– Serves index.html, JS/CSS bundles, resume.pdf, manifest.json, robots.txt, images
4.c. CI/CD Pipeline (GitHub Actions)
– node.js.yml installs dependencies, runs tests, builds production bundle, and deploys
Relationships and data flow
• User → Browser → requests index.html & JS bundle from CDN
• Browser renders React App, loads TailwindCSS styles
• User types commands → Command-Area component captures keystrokes (via keybindings.tsx)
• Commands utility module processes input and returns output → Terminal component displays it
• If user invokes “view resume,” the app navigates or fetches resume.pdf from the static server
Architectural patterns and principles
• Component-based UI: each reusable portion (header, terminal, input area) is its own React component
• Unidirectional data flow in React: parent App passes props/state down to components
• Separation of concerns: UI components vs. utility modules vs. static assets
• Static hosting model: no server-side logic, everything runs in the client
Putting it all together
• Top-level: User’s Browser on the left, CDN/static server in the center, CI/CD on the right