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 committed Sep 23, 2024
1 parent 7523229 commit 3ddcdfe
Show file tree
Hide file tree
Showing 2 changed files with 29 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 ."
}

23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3ddcdfe

Please sign in to comment.