Skip to content

Latest commit

 

History

History
61 lines (52 loc) · 2.54 KB

README.md

File metadata and controls

61 lines (52 loc) · 2.54 KB

CircleCI GitHub license REUSE status

Code Snippet

Description

This extension allows developers to add generic code pieces to their project and provide wizard-like experience with minor development efforts. The repository contains three main packages:

  • Frontend - The Code Snippet as a standalone vue.js application.
  • Backend - The backend part. Runs as a VSCode extension or node.js application.
  • VSCode snippet contributor example - Example snippet contibutor to show usage.

Requirements

Download and Installation

To test run the framework you only need to build and install the backend package, which will automatically build and run the UI.

installation

  • Clone this repository
  • cd into the backend folder
    cd backend
  • To install, compile and prepare the static resources run the following commands:
    npm run backend
    npm run frontend

Usage & Development

Run the dev mode

Dev mode allows you to run the framework in the browser, using vue cli for fast development cycles, and easy debug tools. To run it do the following:

  • In the backend folder run webpack or webpack-dev, then run the server.
    npm run webpack-dev
    npm run ws:run
  • In the frontend folder run serve
    npm run serve
  • Open the broswer on localhost:8080 to access the framework.

Run the VSCode extension

  • Start VSCode on your local machine, and click on open workspace. Select this repo folder.
  • On the debug panel choose "Run Extensions", and click on the "Run" button.

Advanced scenarios

To develop and contribute you can build and install each package separately. Instruction on each package in the dedicated readme.md file.

How to obtain support

To get more help, support, and information please open a github issue.

Contributing

Contributing information can be found in the CONTRIBUTING.md file.