-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
38 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Linux environment setup | ||
|
||
This is a list of step-by-step instructions to set up a Linux 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 `~/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 needs. | ||
|
||
Instruction tested with Ubuntu 24.04.1 LTS | ||
|
||
## Build | ||
|
||
- Install git and curl | ||
- `sudo apt update` | ||
- `sudo apt install git curl` | ||
- Setup node | ||
- Setup [NVM](https://github.com/nvm-sh/nvm) | ||
- `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash` | ||
- `source ~/.bashrc` | ||
- Install Node | ||
- `nvm install --lts` | ||
- Clone and build: | ||
- `git clone https://github.com/microsoft/TypeAgent ~/src/TypeAgent` | ||
- `cd ~/src/TypeAgent/ts` | ||
- `corepack enable` | ||
- `pnpm setup` | ||
- `pnpm i` | ||
- `pnpm run build` | ||
|
||
## Run | ||
|
||
- Setup Service Keys (See instructions [here](./../../ts/README.md#service-keys)) | ||
- Run the TypeAgent shell (without sandbox for electron in Ubuntu 24.04, see [issue](https://github.com/electron/electron/issues/18265)) | ||
- `pnpm run shell --noSandbox` | ||
|
||
## Development | ||
|
||
- Install VSCode ([download](https://code.visualstudio.com/download)) | ||
- Start VSCode in WSL (_Continued from above command prompt in WSL_) | ||
- `code ~/src/TypeAgent/ts` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters