https://github.com/testcontainers/tc-guide-template
Template for a Testcontainers Guide
https://github.com/testcontainers/tc-guide-template
Last synced: 8 months ago
JSON representation
Template for a Testcontainers Guide
- Host: GitHub
- URL: https://github.com/testcontainers/tc-guide-template
- Owner: testcontainers
- License: mit
- Created: 2023-03-10T03:57:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-25T11:44:04.000Z (over 2 years ago)
- Last Synced: 2024-05-22T18:20:27.393Z (over 1 year ago)
- Size: 3.91 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GUIDE_TITLE
This is sample code for [GUIDE_TITLE](https://testcontainers.com/guides/GUIDE_URL) Guide.
## 1. Setup Environment
Make sure you have a [compatible Docker environment](https://www.testcontainers.org/supported_docker_environment/) installed.
```shell
$ docker version
...
Server: Docker Desktop 4.12.0 (85629)
Engine:
Version: 20.10.17
API version: 1.41 (minimum version 1.12)
Go version: go1.17.11
...
```
* Add language-specific prerequisites here
**For Java:**
Make sure you have Java 8+ installed.
If you are going to use Maven build tool then make sure Java 17+ is installed.
For example:
```shell
$ java -version
openjdk version "17.0.4" 2022-07-19
OpenJDK Runtime Environment Temurin-17.0.4+8 (build 17.0.4+8)
OpenJDK 64-Bit Server VM Temurin-17.0.4+8 (build 17.0.4+8, mixed mode, sharing)
```
## 2. Setup Project
* Clone the repository
```shell
git clone https://github.com/testcontainers/TC_GUIDE_REPO_NAME.git
cd TC_GUIDE_REPO_NAME
```
* Open the **TC_GUIDE_REPO_NAME** project in your favorite IDE.
## 3. Run Tests
Run the command to run the tests.
```shell
$ ./gradlew test //for Gradle
$ ./mvnw verify //for Maven
$ go test ./... //for Go
$ npm test //for Node
```
The tests should pass.