Skip to content

Frontend Documentation

Jump to bottom
Thariq Ridha edited this page Apr 26, 2021 · 14 revisions

Frontend

The front-end is a working VSCode Extension that makes use of VSCode's Autocompletion API to provide a autocomplete suggestion from our backend server.

Current Status

Currently, whenever the user types in a Python file, the extension submits a POST request containing the entire file contents along with cursor position. It expects to receive a response that it will then provide as an autocomplete suggestion.

Required Packages

  • TypeScript npm install -g typescript

These should not have to be installed explicitly as they are described in package-lock.json

  • node-url
  • axios

Build/Setup Instructions

  1. Clone repository and open in terminal
  2. Install required packages
  3. Open VSCode (Latest stable build, known to work on 1.55.2)
  4. Open frontend folder (File -> Open...)
  5. Click Run -> Start Debugging (F5)
  6. A new VSCode window should have opened. In it, open a Python file or create a new file and save as .py
  7. Start typing, autocomplete suggestions should be provided.
Clone this wiki locally