From 3ddcdfee16b4201d19e68d7cfe2468cb87926be3 Mon Sep 17 00:00:00 2001
From: Akash <akashsuresh0510@gmail.com>
Date: Mon, 23 Sep 2024 09:54:20 +0530
Subject: [PATCH] Add dev container

Add dev container

Closes https://github.com/StackGuardian/tirith/issues/175

Update Readme.MD
---
 .devcontainer/devcontainer.json |  6 ++++++
 README.md                       | 23 +++++++++++++++++++++++
 2 files changed, 29 insertions(+)
 create mode 100644 .devcontainer/devcontainer.json

diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
new file mode 100644
index 0000000..ee50c07
--- /dev/null
+++ b/.devcontainer/devcontainer.json
@@ -0,0 +1,6 @@
+{
+  "name": "Tirith Dev Container",
+  "image": "mcr.microsoft.com/devcontainers/python:3.11",
+  "postCreateCommand": "pip install -e ."
+}
+
diff --git a/README.md b/README.md
index 2c03d9e..a22b963 100644
--- a/README.md
+++ b/README.md
@@ -80,6 +80,29 @@ This is only a list of approved features that will be included in Tirith over th
 ```
 pip install git+https://github.com/StackGuardian/tirith.git
 ```
+# Development Container Setup
+This guide will help you set up and run a development container.
+
+## Prerequisites
+- **Docker**: Ensure you have Docker installed on your machine. Download and install it from [Docker's official site](https://www.docker.com/products/docker-desktop).
+- **VS Code**: You should have Visual Studio Code installed.
+  
+**Install the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in VS Code.**
+
+## Running the Dev Container
+- Clone the repository to your local machine:
+
+```bash
+   git clone <repository-url>
+   cd <repository-folder>
+```
+- 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 **Remote-Containers: 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.
 
 ### For developers
 Here we are going to install Tirith in a Python virtual environment.