https://github.com/k0msenapati/terminalfolio
TermFolio is an interactive terminal-style portfolio template that simulates a command-line interface in the browser. It's designed to showcase your projects, skills, and information in a unique and engaging way.
https://github.com/k0msenapati/terminalfolio
portfolio shell
Last synced: 10 days ago
JSON representation
TermFolio is an interactive terminal-style portfolio template that simulates a command-line interface in the browser. It's designed to showcase your projects, skills, and information in a unique and engaging way.
- Host: GitHub
- URL: https://github.com/k0msenapati/terminalfolio
- Owner: k0msenapati
- License: mit
- Created: 2024-02-25T15:46:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-31T11:53:12.000Z (about 2 months ago)
- Last Synced: 2025-05-07T20:38:15.265Z (10 days ago)
- Topics: portfolio, shell
- Language: JavaScript
- Homepage:
- Size: 83 KB
- Stars: 12
- Watchers: 1
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
TerminalFolio
> **Interactive Terminal Portfolio Template**
> Simulates a command-line interface to showcase your projects and skills uniquely.
## ✨ Features
✅ **Interactive Terminal Interface** – Realistic command-line experience
✅ **Custom Commands** – Easily configurable JSON-based commands
✅ **Themes** – Multiple built-in themes with a switch option
✅ **Responsive Design** – Works on desktop & mobile
✅ **Social Integration** – Connect GitHub, LinkedIn, Twitter
💻 Commands
### 🛠 General Commands
- `help` – Show available commands
- `clear` – Clear the terminal
- `echo [text]` – Display text
- `ls` – List files
- `cat [file]` – Show file contents
- `man [command]` – Show manual
- `banner` – Display welcome message
### 🚀 Special Commands
- `whois` – About you
- `projects` – Show your projects
- `contact` – Your contact info
- `social` – Social links
- `theme [name]` – Change theme
## ⚙️ Customization
Customizable commands that showcase your personal information, projects, and skills:
- `whois` - Display information about you
- `whoami` - Information for the visitor
- `projects` - Showcase your projects
- `contact` - Display contact information
- `social` - Show social media links
- `joke` - Display a random programming joke
- `theme [name]` - Change the terminal theme
- `matrix` - Apply a matrix effect. Press Esc to exit
- `rps [rock|paper|scissor]` - Start a round of rock-paper-scissor with the terminal
## Customization
TermFolio is designed to be easily customizable without editing the core code:
### Configuration Files
Edit the following JSON files under the `src/config` directory to modify commands, social links, and descriptions:
- `user.json` - Contains user-specific information like name, bio, and contact details.
- `config.json` - General configuration settings for the terminal interface.
- `commands.json` - Defines the commands and their respective outputs.
Example `user.json`:
```json
{
"name": "Your Name",
"bio": "A short bio about yourself",
"contact": {
"email": "[email protected]",
"phone": "123-456-7890"
}
}
```
Example `config.json`:
```json
{
"title": "TermFolio",
"description": "Interactive CLI Portfolio",
"theme": "default"
}
```
Example `commands.json`:
```json
{
"specialCommands": {
"whois": { "output": "Your bio here", "description": "About you" },
"projects": { "output": "Your projects list", "description": "Show projects" }
},
"socials": {
"github": "GitHub",
"linkedin": "LinkedIn"
}
}
```
---
## 📂 Setup & Deployment
1. **Fork the Repository** – Click the **"Fork"** button at the top-right of the repo on GitHub.
2. **Clone Your Forked Repo:**
```sh
git clone https://github.com/your-username/TermFolio.git
```
*(Replace `your-username` with your GitHub username.)*
3. **Customize JSON & Styles:**
Modify `commands.json` & `styles.css` as needed.
4. **Deploy:**
Host it on **GitHub Pages**.
## 🛠 Technologies
---
## 🤝 Contributing
🚀 Feel free to create issues or submit pull requests to improve TermFolio!
Open Source Programs
Apertre 2.0
This project is part of Apertre 2.0. We welcome contributions from the community.
Tip from us 😇
It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪
Show Your Support
If you find this project interesting and inspiring, please consider showing your support by starring it on GitHub! Your star goes a long way in helping us to reach more developers and encourages to keep enhancing the project.