sniffy

(β˜… 194)

Sniffy - interactive profiler, testing and chaos engineering tool for Java

  • .env.local.example
  • .gitignore
  • .travis.yml
  • AGENTS.md
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • CONTRIBUTING.md
  • LICENSE
  • mvnretry.bat
  • pom.xml
  • README.md
  • RELEASENOTES.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/sniffy/sniffy

Downloads the entire project code from GitHub to your computer.

cd sniffy

Moves into the project folder you just downloaded.

2. Maven (Java)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
mvn clean install

Installs dependencies and builds the project using Maven.

βœ… A BUILD SUCCESS message means it worked. The output is created under target/.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd sniffy-ui/apps/agent

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation