README.md 1.05 KB
Newer Older
Ivar Meikas's avatar
Ivar Meikas committed
1
# TeIS commons-public
Enriko Käsper's avatar
Enriko Käsper committed
2

Ivar Meikas's avatar
Ivar Meikas committed
3 4 5
Public libraries containing TeIS base objects and functionality.
This project is meant to be used as a base for project specific commons library.
There are three base libraries: 
Enriko Käsper's avatar
Enriko Käsper committed
6 7 8
 * **service-request-public-lib** - base objects for communication, messages, errors and configuration.
 * **domain-public-lib** - base object for domain objects.
 * **data-types-lib** - base class for object status and helpers for sensitive data manipulation.
Jyrgen Hannus's avatar
Jyrgen Hannus committed
9

Enriko Käsper's avatar
Enriko Käsper committed
10
## Building and testing
Ivar Meikas's avatar
Ivar Meikas committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

Executing tests:

```jshelllanguage
./gradlew check
```

Building and deploying to local maven repository:
```jshelllanguage
./gradlew publishToMavenLocal
```

Building and deploying to artifactory:
```jshelllanguage
./gradlew artifactoryPublish -PartifactoryPublishRepoKey=$ARTIFACTORY_KEY
```

Enriko Käsper's avatar
Enriko Käsper committed
28
## Using TeIS commons-public
Ivar Meikas's avatar
Ivar Meikas committed
29 30 31 32 33 34 35 36

When implementing project specific commons library, include required library with api command. 
For example implementing project specific data types, in build.gradle use:
```groovy
dependencies {
    api "ee.sm.ti.teis:data-types-public-lib:${publicVersion}"
}
```