Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.38 KB

setup-Windows.md

File metadata and controls

38 lines (28 loc) · 1.38 KB
layout title
docs
Windows environment setup

This is a list of step-by-step instructions to set up a Windows environment from scratch to build, run, and develop the TypeAgent repo, collated from various READMEs throughout the repo and external source. The instruction will install and setup the necessary tools and put the repo in C:\src\TypeAgent. Links to the original instructions for each part are provided for reference, but mostly not required to visit if you just follow the instructions here. Skip or change the steps as necessary to suit your existing or desired environment.

Build

  • Install Git (instructions)
  • Install NodeJS (instructions)
  • Enable corepack
    • Open Command Prompt as Administrator
    • corepack enable
  • Clone and build:
    • Open command prompt
    • git clone https://github.com/microsoft/TypeAgent C:\src\TypeAgent (Note: you can clone this to any location and does not have to be C:\src)
    • cd /d C:\src\TypeAgent\ts
    • pnpm setup
    • pnpm i
    • pnpm run build

Configure Services

  • Setup Service Keys (See instructions here)

Run

  • Run the TypeAgent shell
    • pnpm run shell

Development

  • Install VSCode (download)
  • Start VSCode
    • Open command prompt
    • code C:\src\TypeAgent\ts