VulnerableCode documentation

Welcome to VulnerableCode! In this documentation you’ll find information on:

• An overview of VulnerableCode

• Installation instructions

• How to make technical contributions to the project and the community

Getting Started

• VulnerableCode Overview
  • Why VulnerableCode ?
  • How does it work ?
  • Should I use VulnerableCode ?
• Installation
  • Run with Docker
  • Local development installation
  • Using Nix
• Contributing to VulnerableCode
  • Do Your Homework
  • Ways to Contribute
  • Helpful Resources
• FAQ
  • During development, how do I quickly empty my database and start afresh ?
• Miscellaneous
  • Continuous periodic Data import
  • Environment variables configuration

Tutorial

• Add a new importer
  • TL;DR
  • Prerequisites
  • Writing an importer
• Add a new improver
  • TL;DR
  • Prerequisites
  • Writing an improver

Reference Documentation

• Importer Overview
• Improver Overview
• Framework Overview
• Command Line Interface
  • $ ./manage.py --help
  • $ ./manage.py <subcommand> --help
  • $ ./manage.py import <importer-name>
  • $ ./manage.py improve <improver-name>

Summer of Codes

• Google Summer of Code 2021 Final Report

Indices and tables

• Index

• Module Index

• Search Page