Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (50 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

70 lines (50 loc) · 1.45 KB

Contributing

Layout

algebras/                   Algebra interfaces
akka-http/                  Interpreters based on Akka-http
play/                       Interpreters based on Play framework
scalaj/                     Interpreters based on Scalaj
xhr/                        Scala.js interpreters based on XMLHttpRequest
openapi/                    Interpreters generating OpenAPI documentation
testsuite/                  Test kit
documentation/              User manual and examples
sbt-assets/                 Sbt settings to help handling assets

Cheat sheet

Compile the project

$ sbt +compile

Run the tests

$ sbt +test

or for faster feedback loop:

$ sbt "+++ 2.11.12 test"
$ sbt "+++ 2.12.8 test"
$ sbt "+++ 2.13.0-M5 test"

Preview the documentation

$ sbt +manual/previewSite

And then go to http://localhost:4000.

Publish the documentation

$ sbt +manual/ghpagesPushSite

Run the examples

+++ 2.12.4 example-basic-play-server/run

Working with mill

Endpoints comes with experimental mill build which is meant for evaluating mill as a replacecement for sbt

mill genidea #generate idea project config
mill all __.compile #compile everything
mill all __.test #test everything

After generating intellij project you may need to navigate to Settings -> Languages & Frameworks -> Worksheet and set inteprpretation mode to "Always Ammonite"