Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created an example app #212

Merged
merged 11 commits into from
Aug 1, 2022
Merged

Created an example app #212

merged 11 commits into from
Aug 1, 2022

Conversation

LukaszKontowski
Copy link
Contributor

@LukaszKontowski LukaszKontowski commented Jul 30, 2022

  • example-app runs properly with cluster nodes started from separate terminal windows
  • example-app runs (or just compiles?) as a part of standard ci. If it should run - then logic should be changed so that it runs for a short time and then a shutdown is performed
  • README and GUIDE updated (tell users about this example app)
  • logic for dump-persistence-schema added (currently missing) - will be done within Add real dumping of persistence-schema to examples/ #216
  • .scala-steward.conf updated with example-app
  • this particular example project is built in the CI workflow
  • both example projects are scalafmt-checked just as the top-level project (in CI)
  • MAYBE: change example-app logic? (now it is mostly copied from akka-samples-cluster-scala ...) Not needed, we can use it.
  • MAYBE: CI updated so that after release is published - ASH version in examples/example-app/build.sbt is bumped automatically? (or maybe Scala Steward will do it afterwards in it's PR?) (scala steward should do it - we'll see)

@LukaszKontowski LukaszKontowski added feature New feature or request docs labels Jul 30, 2022
@LukaszKontowski LukaszKontowski self-assigned this Jul 30, 2022
@LukaszKontowski
Copy link
Contributor Author

LukaszKontowski commented Jul 30, 2022

to be done:

  • change example-app logic maybe? (now it just mostly copied from akka-samples-cluster-scala ...)
  • make example-app run (or just compile?) as a part of standard ci - if run - then logic should be changed so that it runs for a short time and then a shutdown is performed
  • update README and GUIDE - tell users about this example app
  • add logic for dump-persistence-schema (currently missing)
  • update CI so that after release is published - ASH version in examples/example-app/build.sbt is bumped automatically (or maybe Scala Steward will do it afterwards in it's PR?)
    • all Pawel's suggestions

@PawelLipski
Copy link
Collaborator

to be done:

Btw you can move it to PR description, and use the checkboxes:

- [ ] change example-app logic maybe? (now it just mostly copied from akka-samples-cluster-scala ...)
- [ ] ....

This way you can tick off the stuff that's done

@LukaszKontowski
Copy link
Contributor Author

Code from the https://github.com/akka/akka-samples/tree/2.6/akka-sample-cluster-scala is in following files:

examples/example-app/src/main/scala/org/virtuslab/example/App.scala
examples/example-app/src/main/scala/org/virtuslab/example/StatsClient.scala
examples/example-app/src/main/scala/org/virtuslab/example/StatsService.scala
examples/example-app/src/main/scala/org/virtuslab/example/StatsWorker.scala
examples/example-app/src/main/resources/logback.xml
examples/example-app/src/main/resources/example.conf

( // our code comments added for our pieces of code )

All the rest is ours.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@LukaszKontowski LukaszKontowski marked this pull request as ready for review August 1, 2022 14:51
pre-commit Outdated Show resolved Hide resolved
@PawelLipski PawelLipski linked an issue Aug 1, 2022 that may be closed by this pull request
@LukaszKontowski LukaszKontowski enabled auto-merge (squash) August 1, 2022 15:37
@LukaszKontowski LukaszKontowski merged commit 87940d7 into main Aug 1, 2022
@LukaszKontowski LukaszKontowski deleted the example_app branch August 1, 2022 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create end-to-end example of a working app under examples/
2 participants