Skip to content

Commit

Permalink
Add dev container
Browse files Browse the repository at this point in the history
Add dev container

Closes StackGuardian#175

Update Readme.MD
  • Loading branch information
AkashS0510 authored and samriddhi99 committed Sep 25, 2024
1 parent 4eb27f7 commit f1d40f6
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "Tirith Dev Container",
"image": "mcr.microsoft.com/devcontainers/python:3.11",
"postCreateCommand": "pip install -e ."
}

28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,34 @@ pip install git+https://github.com/StackGuardian/tirith.git
```

### For developers

#### Running the Dev Container

- Clone the repository to your local machine:

```bash
git clone <repository-url>
cd <repository-folder>
```

- Start the Docker Engine using docker desktop or CLI.

- Open the project folder in Visual Studio Code

- Once inside VS Code, open the Command Palette `(Ctrl+Shift+P or Cmd+Shift+P on macOS)` and search for **Dev Containers: Rebuild and Reopen in Container**. Select this option.

- VS Code will build the dev container based on the devcontainer.json file or Docker configuration provided in the project. This may take a few minutes.

- Once the container is up, you will have a fully configured development environment running inside Docker.

Reference Links:

https://code.visualstudio.com/docs/devcontainers/create-dev-container#_create-a-devcontainerjson-file

https://code.visualstudio.com/docs/devcontainers/containers#_managing-containers


#### Manual Installation
Here we are going to install Tirith in a Python virtual environment.

1. Clone the Tirith repository to your system
Expand Down

0 comments on commit f1d40f6

Please sign in to comment.