https://github.com/jsmith/vue-terminal

A terminal written for Vue!
https://github.com/jsmith/vue-terminal

Last synced: 2 days ago
JSON representation

A terminal written for Vue!

• Host: GitHub
• URL: https://github.com/jsmith/vue-terminal
• Owner: jsmith
• Created: 2018-09-01T01:12:16.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-17T16:23:26.000Z (over 4 years ago)
• Last Synced: 2024-10-13T17:39:00.312Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://jsmith.github.io/vue-terminal
• Size: 1.18 MB
• Stars: 15
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vue-terminal

`vue-terminal` is a terminal emulator written in Vue. It is currently being used to power my [portfolio site](https://jsmith.github.io).



## Installation

Just install using npm!

```

npm install @jsmith21/vue-terminal

```

## Usage

Register the plugin:

```

import Vue from 'vue';

import plugin from '@jsmith21/vue-terminal';

Vue.use(plugin);

```

Define your file system object:

```

const fs = {

  home: {

    jacob: {

      'git': {},

      'Downloads': {},

      'Documents': {},

      'folder1': {},

      'folder2': {},

      'Desktop': {},

      '.bashrc': 'alias ll="ls -l"\ncd ~',

      'random.file': 'github.com is great',

    },

  },

};

```

Then, in your `Vue` template, pass in all of the props:

```

```

See [stories.ts](https://github.com/jsmith/vue-terminal/blob/master/src/stories.ts) for a working example using Storybook!

## Project setup

```

npm i

```

### Startup the Development Environment (Storybook)

```

npm run serve:storybook

```

### Publishing

```

VERSION="YOUR_VERSION"

npm run bundle

git add .

git commit -m "$VERSION"

git tag v$VERSION

git push

npm publish

```