Archives/langchain
2
0
Fork 1
mirror of https://github.com/hwchase17/langchain synced 2024-10-31 15:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
256849e02a
langchain/.devcontainer/README.md
Luis Valencia 7124377524
Devcontainer README -> Clarification. (#8414) 
- Description: The contribution guidlelines using devcontainer refer to
the main repo and not the forked repo. We should create our changes in
our own forked repo, not on langchain/main
  - Issue: Just documentation
  - Dependencies: N/A,
  - Tag maintainer: @baskaryan
  - Twitter handle: @levalencia
2023-07-28 15:09:42 -07:00

3.3 KiB
Raw Blame History

Dev container

This project includes a dev container, which lets you use a container as a full-featured dev environment.

You can use the dev container configuration in this folder to build and run the app without needing to install any of its tools locally! You can use it in GitHub Codespaces or the VS Code Dev Containers extension.

GitHub Codespaces

Open in GitHub Codespaces

You may use the button above, or follow these steps to open this repo in a Codespace:

  1. Click the Code drop-down menu at the top of https://github.com/hwchase17/langchain.
  2. Click on the Codespaces tab.
  3. Click Create codespace on master .

For more info, check out the GitHub documentation.

VS Code Dev Containers

Open in Dev Containers

Note: If you click this link you will open the main repo and not your local cloned repo, you can use this link and replace with your username and cloned repo name: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com//

If you already have VS Code and Docker installed, you can use the button above to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.

You can also follow these steps to open this repo in a container using the VS Code Dev Containers extension:

  1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the getting started steps.

  2. Open a locally cloned copy of the code:

    • Fork and Clone this repository to your local filesystem.
    • Press F1 and select the Dev Containers: Open Folder in Container... command.
    • Select the cloned copy of this folder, wait for the container to start, and try things out!

You can learn more in the Dev Containers documentation.

Tips and tricks

  • If you are working with the same repository folder in a container and Windows, you'll want consistent line endings (otherwise you may see hundreds of changes in the SCM view). The .gitattributes file in the root of this repo will disable line ending conversion and should prevent this. See tips and tricks for more info.
  • If you'd like to review the contents of the image used in this dev container, you can check it out in the devcontainers/images repo.