{"id":19973295,"url":"https://github.com/jsmith/vue-terminal","last_synced_at":"2025-05-04T02:31:53.485Z","repository":{"id":57122512,"uuid":"146956410","full_name":"jsmith/vue-terminal","owner":"jsmith","description":"A terminal written for Vue!","archived":false,"fork":false,"pushed_at":"2020-03-17T16:23:26.000Z","size":1238,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-18T23:54:24.270Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://jsmith.github.io/vue-terminal","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsmith.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-01T01:12:16.000Z","updated_at":"2024-10-17T15:05:24.000Z","dependencies_parsed_at":"2022-08-24T14:59:30.684Z","dependency_job_id":null,"html_url":"https://github.com/jsmith/vue-terminal","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsmith%2Fvue-terminal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsmith%2Fvue-terminal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsmith%2Fvue-terminal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsmith%2Fvue-terminal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsmith","download_url":"https://codeload.github.com/jsmith/vue-terminal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252278964,"owners_count":21722795,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T03:10:57.377Z","updated_at":"2025-05-04T02:31:52.378Z","avatar_url":"https://github.com/jsmith.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vue-terminal\n`vue-terminal` is a terminal emulator written in Vue. It is currently being used to power my [portfolio site](https://jsmith.github.io).\n\n\u003ca href=\"https://ibb.co/cmSQh0\"\u003e\u003cimg src=\"https://preview.ibb.co/dK3y20/Screenshot-from-2018-11-16-08-08-13.png\" alt=\"Screenshot-from-2018-11-16-08-08-13\" border=\"0\" /\u003e\u003c/a\u003e\n\n## Installation\nJust install using npm!\n```\nnpm install @jsmith21/vue-terminal\n```\n\n## Usage\nRegister the plugin:\n```\nimport Vue from 'vue';\nimport plugin from '@jsmith21/vue-terminal';\nVue.use(plugin);\n```\n\nDefine your file system object:\n```\nconst fs = {\n  home: {\n    jacob: {\n      'git': {},\n      'Downloads': {},\n      'Documents': {},\n      'folder1': {},\n      'folder2': {},\n      'Desktop': {},\n      '.bashrc': 'alias ll=\"ls -l\"\\ncd ~',\n      'random.file': 'github.com is great',\n    },\n  },\n};\n```\n\nThen, in your `Vue` template, pass in all of the props:\n```\n\u003cterminal \n  user=\"jacob\" \n  :file-system=\"fs\" \n  welcome=\"This is the welcome text: https://github.com/jsmith\"\n\u003e\u003c/terminal\u003e\n```\n\n\nSee [stories.ts](https://github.com/jsmith/vue-terminal/blob/master/src/stories.ts) for a working example using Storybook!\n\n## Project setup\n```\nnpm i\n```\n\n### Startup the Development Environment (Storybook)\n```\nnpm run serve:storybook\n```\n\n### Publishing\n```\nVERSION=\"YOUR_VERSION\"\nnpm run bundle\ngit add .\ngit commit -m \"$VERSION\"\ngit tag v$VERSION\ngit push\nnpm publish\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsmith%2Fvue-terminal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsmith%2Fvue-terminal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsmith%2Fvue-terminal/lists"}