Skip to content

Commit

Permalink
Fix readmes (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
rogervinas authored Nov 20, 2023
1 parent 4eb6e0d commit e995906
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 43 deletions.
4 changes: 1 addition & 3 deletions go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@

# Go

[Go](https://go.dev/) testing
[Go](https://go.dev/) testing with core libraries

## Run this project using 🐳 [docker](https://www.docker.com/)
* Go to [go](go) folder
* Execute `./docker-run.sh`
* Once inside the container:
* Test with `go test -test.v`
Expand All @@ -18,7 +17,6 @@
* Install [Go](https://go.dev/dl/)

### Run locally
* Go to [go](go) folder
* Test with `go test -test.v`
* Run with `go run .`

Expand Down
24 changes: 13 additions & 11 deletions java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,30 @@
[Java](https://openjdk.org/) testing with [JUnit5](https://junit.org/junit5/), [Mockito](https://site.mockito.org/) and [AssertJ](https://assertj.github.io/doc/)

## Run this project using 🐳 [docker](https://www.docker.com/)
* Go to [java](java) folder
* Execute `./docker-run.sh`
* Once inside the container:
* Test with `./gradlew test`
* Run with `./gradlew run`
* Test with `./gradlew test`
* Run with `./gradlew run`

## Run this project locally

### Pre-requisites
* Install [Java](https://openjdk.org/) and [Gradle](https://gradle.org/) manually or ...
* Install [SdkMan](https://sdkman.io/) and ...
* List available versions executing `sdk list java` and `sdk list gradle`
* Install **Java** executing `sdk install java 21-tem`
* Install **Gradle** executing `sdk install grade 8.4`
* Install [SdkMan](https://sdkman.io/) and ...
* List available versions executing `sdk list java` and `sdk list gradle`
* Install **Java** executing `sdk install java 21-tem`
* Install **Gradle** executing `sdk install grade 8.4`

### Run locally
* Go to [java](java) folder
* Test with `./gradlew test`
* Run with `./gradlew run`

### Create project from scratch
* Create project using `gradle init --type java-application --dsl kotlin --test-framework junit-jupiter`
* Add [Mockito](https://site.mockito.org/) and [AssertJ](https://assertj.github.io/doc/) dependencies in [build.gradle.kts](java/build.gradle.kts):
* `testImplementation("org.mockito:mockito-core:x.x.x")`
* `testImplementation("org.assertj:assertj-core:x.x.x")`
* Add [Mockito](https://site.mockito.org/) and [AssertJ](https://assertj.github.io/doc/) dependencies in [build.gradle.kts](build.gradle.kts):
```kotlin
dependencies {
testImplementation("org.mockito:mockito-core:x.x.x")
testImplementation("org.assertj:assertj-core:x.x.x")
}
```
14 changes: 6 additions & 8 deletions javascript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,21 @@
[JavaScript](https://developer.mozilla.org/docs/Web/JavaScript) testing with [Jest](https://jestjs.io/)

## Run this project using 🐳 [docker](https://www.docker.com/)
* Go to [javascript](javascript) folder
* Execute `./docker-run.sh`
* Once inside the container:
* First time only, install dependencies with `npm install`
* Test with `npm test`
* Run with `npm start`
* First time only, install dependencies with `npm install`
* Test with `npm test`
* Run with `npm start`

## Run this project locally

### Pre-requisites
* Install [Node.js](https://nodejs.org/en/) manually or ...
* Install [Node Version Manager](https://github.com/nvm-sh/nvm) and ...
* List available versions executing `nvm list`
* Install **Node.js** executing `nvm use v18` or `nvm use stable`
* Install [Node Version Manager](https://github.com/nvm-sh/nvm) and ...
* List available versions executing `nvm list`
* Install **Node.js** executing `nvm use v18` or `nvm use stable`

### Run locally
* Go to [javascript](javascript) folder
* First time only, install dependencies with `npm install`
* Test with `npm test`
* Run with `npm start`
Expand Down
23 changes: 13 additions & 10 deletions kotlin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,19 @@
[Kotlin](https://kotlinlang.org/) testing with [Kotest](https://kotest.io) and [MockK](https://mockk.io/)

## Run this project using 🐳 [docker](https://www.docker.com/)
* Go to [kotlin](kotlin) folder
* Execute `./docker-run.sh`
* Once inside the container:
* Test with `./gradlew test`
* Run with `./gradlew run`
* Test with `./gradlew test`
* Run with `./gradlew run`

## Run this project locally

### Pre-requisites
* Install [Java](https://openjdk.org/) and [Gradle](https://gradle.org/) manually or ...
* Install [SdkMan](https://sdkman.io/) and ...
* List available versions executing `sdk list java` and `sdk list gradle`
* Install **Java** executing `sdk install java 21-tem`
* Install **Gradle** executing `sdk install grade 8.4`
* Install [SdkMan](https://sdkman.io/) and ...
* List available versions executing `sdk list java` and `sdk list gradle`
* Install **Java** executing `sdk install java 21-tem`
* Install **Gradle** executing `sdk install grade 8.4`

### Run locally
* Go to [kotlin](kotlin) folder
Expand All @@ -29,6 +28,10 @@

### Create project from scratch
* Create project using `gradle init --type kotlin-application --dsl kotlin --test-framework kotlintest`
* Add [Kotest](https://kotest.io) and [MockK](https://mockk.io/) dependencies in [build.gradle.kts](kotlin/build.gradle.kts):
* `testImplementation("io.kotest:kotest-runner-junit5:x.x.x")`
* `testImplementation("io.mockk:mockk:x.x.x")`
* Add [Kotest](https://kotest.io) and [MockK](https://mockk.io/) dependencies in [build.gradle.kts](build.gradle.kts):
```kotlin
dependencies {
testImplementation("io.kotest:kotest-runner-junit5:x.x.x")
testImplementation("io.mockk:mockk:x.x.x")
}
```
16 changes: 7 additions & 9 deletions ruby/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,25 @@
[Ruby](https://www.ruby-lang.org) testing with [RSpec](https://rspec.info/)

## Run this project using 🐳 [docker](https://www.docker.com/)
* Go to [ruby](ruby) folder
* Execute `./docker-run.sh`
* Once inside the container:
* First time only, install dependencies with `bundle install`
* Test with `rspec -fd`
* Run with `ruby lib/Main.rb`
* First time only, install dependencies with `bundle install`
* Test with `rspec -fd`
* Run with `ruby lib/Main.rb`

## Run this project locally

### Pre-requisites
* Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) manually or ...
* Install [renv](https://github.com/rbenv/rbenv#readme) version manager and ..
* List available versions executing `rbenv install -l`
* Install **Ruby** executing `rbenv install 3.2.2` and `rbenv global 3.2.2`
* Install [renv](https://github.com/rbenv/rbenv#readme) version manager and ..
* List available versions executing `rbenv install -l`
* Install **Ruby** executing `rbenv install 3.2.2` and `rbenv global 3.2.2`

### Run locally
* Go to [ruby](ruby) folder
* First time only, install dependencies with `bundle install`
* Test with `rspec -fd`
* Run with `ruby lib/Main.rb`

### Create project from scratch
* Just create a [Gemfile](ruby/Gemfile)
* Just create a [Gemfile](Gemfile)
* Execute `bundle install`
2 changes: 0 additions & 2 deletions scala/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
[Scala](https://www.scala-lang.org/) testing with [ScalaTest](https://www.scalatest.org/) and [Mockito](https://www.scalatest.org/plus/mockito)

## Run this project using 🐳 [docker](https://www.docker.com/)
* Go to [java](java) folder
* Execute `./docker-run.sh`
* Once inside the container:
* Test with `sbt test`
Expand All @@ -23,7 +22,6 @@
* Install [Coursier](https://get-coursier.io/) and execute `cs install scala:3.3.1`

### Run locally
* Go to [scala](scala) folder
* Test with `sbt test`
* Run with `sbt run`

Expand Down

0 comments on commit e995906

Please sign in to comment.