BugBountyBlueprint

KO | EN

gitlite — search

#javascript #python #react #java #python3 #reactjs #nodejs #css #kubernetes #unity #cli #rust

BugBountyBlueprint

★ 59 Open GitHub ↗

A tool offering templates for streamlined bug bounty reporting

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bug Bounty Blueprint 💠

provides customizable templates for bug bounty reports. It's designed to simplify the reporting process, letting users focus on identifying vulnerabilities. Frontend in VueJS, Backend in FastAPI.

🌹 This tool was highly inspired by [Frans Rosen's template-generator](https://github.com/fransr/template-generator).

## Features

- **Custom Templates**: Customize or create templates tailored to your needs.
- **Markdown Support**: Write and preview reports in markdown.
- **Instant Preview**: Real-time rendering of your markdown report.

## Docker-Compose installation

1. Clone this repository: 
   ```bash
   git clone https://github.com/PatrikFehrenbach/BugBountyBlueprint.git
   ```
   
2.  Navigate to the project directory:
  ```bash
   cd BugBountyBlueprint
   ```
1. ```bash
   docker-compose up
   ```
2. Visit `http://localhost:8080` in your browser to access **Bug Bounty Blueprint**.

## Installation 🚀

1. Clone this repository:
   ```bash
   git clone https://github.com/PatrikFehrenbach/BugBountyBlueprint.git
   ```

2. Navigate to the project directory:
   ```bash
   cd BugBountyBlueprint
   ```

3. Install backend dependencies:
   ```bash
   cd backend
   pip install -r requirements.txt
   ```

4. Run the FastAPI server:
   ```bash
   uvicorn main:app --reload
   ```

5. In a new terminal, navigate to the frontend directory and install npm packages:
   ```bash
   cd frontend
   npm install
   ```

6. Run the Vue.js frontend:
   ```bash
   npm run serve
   ```

Visit `http://localhost:8080` in your browser to access **Bug Bounty Blueprint**.

## Usage 🛠️

1. Select or create a new template.
2. Fill in the required fields in the template.
3. Instantly preview the rendered markdown report.
4. Copy the markdown or the rendered HTML to use in your bug bounty platform.

## Demo

https://github.com/PatrikFehrenbach/BugBountyBlueprint/assets/9072595/23c1caa9-763b-45cb-acb6-af5fd798ad0f

## Contribute 🤝

Are always welcome, just create a pull request and I'll review it :)

## Buy me a Coffee

No don't.

BugBountyBlueprint

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README