Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (19 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

23 lines (19 loc) · 1.19 KB

Hacking on Savage

How do I build Savage?

  1. Install sbt
  2. Go to your savage directory.
  3. Run sbt compile

How do I run the Savage service locally for test purposes?

This method is not recommended for use in production deployments!

  1. Ensure that sbt is installed (see above).
  2. Go to your savage directory.
  3. Run sbt
  4. At the sbt prompt, enter re-start 9090 (replace 9090 with whatever port you want the HTTP server to run on) or re-start (which will use the default port specified in application.conf). Note that running on ports <= 1024 requires root privileges (not recommended) or using port mapping.

How do I generate a single self-sufficient JAR that includes all of the necessary dependencies?

  1. Ensure that sbt is installed (see above).
  2. Go to your savage directory.
  3. Run sbt assembly
  4. If the build is successful, the desired JAR will be generated as target/scala-2.10/savage-assembly-1.0.jar.

Licensing

Savage is licensed under The MIT License. By contributing to Savage, you agree to license your contribution under The MIT License.