Skip to content

Frontend Walkthrough

Jump to bottom
Joshua Lara edited this page Jun 2, 2021 · 7 revisions

Installation (from repository)

  1. Clone our repository from our home page https://github.com/StanfordCS194/Team11
  2. Install required packages:
  • Typescript: npm install -g typescript
  1. Download latest version of Visual Studio Code https://code.visualstudio.com/
  2. Open VSCode in the "frontend" folder of our repository (1 level down from the root)
  3. At this point, VSCode should recognize that this is an extension. Run CodeBae by going to Run -> Start Debugging (F5). Alternatively, you can use the Run and Debug panel in the left navbar -> Run Extension.
  4. A new VSCode window should have opened to the CodeBae Landing Page. See the Landing Page section for more information. In the VSCode extension window, open a workspace with python files or create one (.py).
  5. Simply begin typing to see CodeBae's autocomplete suggestions! Once authenticated with the backend, you will begin receiving autocomplete suggestions on any python files that you open in your workspace.

Alternative Installation (from VSIC file - in progress)

  1. Download our packaged extension (Place link here)
  2. Open the file and follow the instructions

Landing Page

When starting up VSCode with CodeBae enabled, you will first see the landing page. Here, you can authenticate to the backend with a provisioned API key, manually upload your workspace files to the backend, and toggle if you want your files to be automatically uploaded (whether that be on-save or on extension start).

Success Messages

CodeBae has a variety of success and error messages that appear as VSCode popups.

Clone this wiki locally