Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,27 @@
<target>${java.version}</target>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<id>yarn install build</id>
<phase>generate-sources</phase>
<goals>
<goal>exec</goal>
</goals>
<configuration>
<executable>yarn</executable>
<arguments>
<argument>installAndBuild</argument>
</arguments>
<workingDirectory>${project.basedir}/web-report</workingDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand Down
76 changes: 76 additions & 0 deletions web-report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Web Report

Web Fuzzing Commons (WFC): A set of standards and library support for facilitating fuzzing Web APIs.


## Prerequisites

- Node.js (version 18.x or higher)
- npm (comes with Node.js) or Yarn (version 1.22.x or higher)

## Installation

Install dependencies using npm:
```bash
npm install
```

Or using Yarn:
```bash
yarn install
```

## Development

To start the development server:

```bash
npm run dev
# or
yarn dev
```

The development server will start at `http://localhost:5173` by default.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any specific reason for such odd 5173 number? why not 8080 (standard in Java)? or 3000 (standard in nodejs)?


## Building for Production

To build the project for production:

```bash
npm run build
# or
yarn build
```

The build artifacts will be stored in the `../target/generated-sources/webreport` directory.

## Preview Production Build

To preview the production build locally (uses existing build without rebuilding):

```bash
npm run preview
# or
yarn preview
```

## Debug Mode

To run the application in debug mode using static test files:

```bash
npm run debug
# or
yarn debug
```

This will build the project and copy static test files from `tests/static` directory to `../target/generated-sources/webreport` before previewing.

## Available Scripts

- `dev` - Start development server
- `build` - Build for production
- `preview` - Preview production build
- `lint` - Run ESLint
- `installAndBuild` - Install dependencies, run tests and build (Yarn only)
- `debug` - Build the project and run in debug mode using static test files from `tests/static` directory
Loading