https://github.com/gervinfung/react-unix-terminal

A customizable unix terminal emulator for React on web, with customizable command that is
https://github.com/gervinfung/react-unix-terminal

react terminal typescript

Last synced: 2 months ago
JSON representation

A customizable unix terminal emulator for React on web, with customizable command that is

• Host: GitHub
• URL: https://github.com/gervinfung/react-unix-terminal
• Owner: GervinFung
• License: mit
• Created: 2022-04-18T13:44:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-28T15:58:06.000Z (about 2 years ago)
• Last Synced: 2024-10-22T04:13:03.125Z (2 months ago)
• Topics: react, terminal, typescript
• Language: TypeScript
• Homepage: https://react-unix-terminal.surge.sh
• Size: 301 KB
• Stars: 4
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# **react-unix-terminal**

I think it's interesting to implement/simulate a fake terminal that actually runs a command, execute tasks and return an output

With the catch of going back to plain CSS

Therefore I built it out of boredom

#### Main Page (The only page)

![Demo](./doc/img/demo.png 'Demo')

## Tech Used

| Aspect                                                                 | Name           |

| ---------------------------------------------------------------------- | -------------- |

| Development Language                                                   | TypeScipt      |

| Bundling                                                               | Vite           |

| Testing                                                                | Vitest         |

| Styling                                                                | CSS            |

| Library                                                                | React          |

| Text Editor                                                            | NeoVim         |

| Dependency Management                                                  | Pnpm           |

| Continuous Integration, Continuous Delivery, and Continuous Deployment | GitHub Actions |

## How to build this app?

_*Make sure you have `pnpm` available in your system*_

#### Pnpm Commands

_*Below are the listed commands that you can use to build/develop/test this app*_

| Command           | Usage                                             |

| ----------------- | ------------------------------------------------- |

| pnpm dev          | Start development                                 |

| pnpm test         | Run all test code                                 |

| pnpm build        | Bundle and build the app                          |

| pnpm typecheck    | Run typechecking for source and test code         |

| pnpm lint         | Run linter for source and test code               |

| pnpm format       | Run prettier to format source and test code       |

| pnpm format-check | Run prettier to check source and test code format |

| pnpm installation | Install all dependencies                          |