Overview of term-website

term-website is an innovative and configurable terminal emulator designed for web browsers. Built with vanilla TypeScript, HTML, and CSS, it leverages xterm.js to deliver an authentic shell environment experience, complete with a creative twist: its own mock backend. This project serves as a dynamic template for creating a terminal-style online portfolio or as a standalone interactive terminal emulator.

Key Features

• Interactive Shell-Like Commands: Emulate the behavior of real terminal commands such as ls, cd, cat, and open.
• Customizable Interface: Tailor terminal themes and the file system layout through config.json and the /files/ directory.
• Shortcuts for Efficiency: Includes useful shortcuts like Ctrl + L to clear the terminal and Ctrl + C to cancel current commands, enhancing user interaction.
• Stateless Operations: The terminal resets to its initial configuration upon each refresh, ensuring a clean state.
• Hidden Easter Eggs: Surprises are scattered throughout, awaiting curious exploration.

Configuration Options

Filetree Customization

Alter the files and structure visible in the terminal by modifying the contents of /src/server/file-system/files/.

Command Integration

Expand the terminal's capabilities by adding commands in /src/server/commands/. Ensure that each command adheres to the Command interface, implementing the execute method.

Theming

Modify default themes using config.json. Pre-configured themes include:

• Dracula
• Catpuccin Mocha
• Solarized Dark

To introduce a new theme, implement the ITheme interface within src/client/terminal/themes.ts.

Supported Shortcuts

Shortcut	Functionality
Ctrl + L	Clear terminal
Ctrl + C	Cancel current command
Ctrl + W	Delete last word
Ctrl + U	Delete current line
ArrowUp/ArrowDown	View command history

Roadmap

Future enhancements include:

• TAB Autocomplete: Suggest file names and commands dynamically.
• Markdown Rendering: Preview Markdown documents directly within the terminal.
• Extended Command History: Facilitate navigation through multiline command entries.

Contribution Guidelines

To contribute:

1. Fork the Repository: Clone and branch your own copy.
2. Create a Feature Branch: Name it accordingly using feat/feature-name.
3. Develop and Commit: Make changes, then commit using git commit -am 'Add new feature'.
4. Push and Request Merge: Share your branch and submit a pull request on GitHub.

Inspiration

This project draws inspiration from notable interactive terminal interfaces such as Dustin Brett's terminal portfolio and ProtiumX.

Explore the term-website to experience its features in action.