Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maxneuvians authored Nov 22, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent 7da8b11 commit 6be2b1d
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -3,11 +3,19 @@ Built on top of the Threat Composer Tool by Amazon (https://awslabs.github.io/th
This version consolidates the 2 original projects (threat-composer & threat-composer-app) into a single project and removes the 3rd project entirely (threat-composer-infra) as we will be using a different deployment topology.
It also adds a new dependency @projectstorm/react-diagrams, for further development of a DFD builder.

## Features included in this MVP (yet to be developed)
## Features included in this MVP

- Interactive Dataflow Diagram builder: facilitates STRIDE-per-element threat modeling
- Questionnaire-based selection of security controls

## Quickstart using the devcontainer
### Watch a Demo of the CDS Threat Modeling Tool on YouTube
[![Demo of CDS threatmodeling tool ](https://github.com/cds-snc/threat-modeling-tool/assets/867334/fd4e0600-1ed5-43c8-bf79-3b4a2e7f6cd8)](http://www.youtube.com/watch?v=YhZtjF4nlBA)

## Quickstart using codespaces
1. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/cds-snc/threat-modeling-tool)
2. The codespace will install and build the initial app, so all you need to do get it running is run `npm start` in the terminal.

## Quickstart using the devcontainers
1. Clone the repo ``git clone https://github.com/cds-snc/threat-modeling-tool.git``
2. Using [VS Code](https://code.visualstudio.com/) and the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers), select ``Dev Containers: Open Folder in Container...`` and select the project folder.
3. The devcontainer will install and build the initial app, so all you need to do get it running is run `npm start` in the terminal.
3. The devcontainer will install and build the initial app, so all you need to do get it running is run `npm start` in the terminal.

0 comments on commit 6be2b1d

Please sign in to comment.