Skip to content

Adjust instructions for Scala Job template #67

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.

Sign up for GitHub

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

Merged
lennartkats-db merged 4 commits into from
Mar 2, 2025
Merged

Adjust instructions for Scala Job template #67

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
104534d
Adjust instructions for Scala Job template
nija-at Feb 28, 2025
ed50746
Apply suggestions from code review
nija-at Feb 28, 2025
0ba50df
Apply suggestions from code review
nija-at Feb 28, 2025
7617fe6
Update contrib/templates/scala-job/template/{{.project_name}}/README.…
nija-at Feb 28, 2025
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
20 changes: 16 additions & 4 deletions contrib/templates/scala-job/template/{{.project_name}}/README.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,26 @@ The '{{.project_name}}' project was generated by using the scala-job template.
## Local Devloop

### Prerequisites
- sbt v1.10.2 or later
- java 17

The following projects need to be installed:
- [sbt](https://www.scala-sbt.org/) v1.10.2 or later
- Java 17

### Running via sbt

1. On the terminal, navigate to the project's root directory. This is the directory where the `build.sbt` file is located.
2. Execute the project's default `Main` class by running `sbt run`.

### IntelliJ setup

Install the latest [IntelliJ IDEA](https://www.jetbrains.com/idea/) IDE, both Community and Professional Editions work.
Install the [Scala plugin](https://plugins.jetbrains.com/plugin/1347-scala) from the Jetbrains marketplace.

1. Import the current directory in your ide (we recommend IntelliJ) where build.sbt is located. Verify it is imported as sbt project.
2. If you don’t have java, in Intellij, go to File -> Project Structure, SDKs -> + sign to add 17 -> OK
2. Choose the correct Java version in IntelliJ, go to File -> Project Structure -> SDKs.

Then Run -> Edit Configurations -> Set version to Java 17 from drop
3. You should now be able to run the code with the UI but you can also just simply run `sbt run` in the terminal.
3. You should now be able to run the code directly in the IDE via the ▶️ option.

## Customizations

Expand Down