Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.33 KB

README.md

File metadata and controls

64 lines (43 loc) · 1.33 KB

react-unix-terminal

I want to build a web terminal, not a real one of course, but to simulate one with executable command

Therefore I built it, then I figure it can be published as NPM package

Hence, I published it

How do I use it?

import React from 'react';
import ReactDOM from 'react-dom';
import ReactUnixTerminal from 'react-unix-terminal';
import 'react-unix-terminal/build/style.css';

ReactDOM.render(
    <React.StrictMode>
        <ReactUnixTerminal
            user="guest"
            name="poolofdeath20"
            fontFamily="JetBrains+Mono"
            height="100vh"
            width="100%"
        />
    </React.StrictMode>,
    document.getElementById('root'),
);

Will show in web as

alt output

Can I raise an issue?

Why not? Feel free to raise an issue if you have a question, an enhancement, or a bug report.

Can I contribute

I need help for the following features 🙂

  • More usable default command

However, before contributing, I would prefer if you could

  • Use TypeScript
  • Write Test Code

Changes

Kindly refer to CHANGELOG

How to install

yarn add react-unix-terminal

OR

npm i react-unix-terminal