https://github.com/maslick/barkoder
a minimalistic WMS system, back-end
https://github.com/maslick/barkoder
artifactory barkoder bintray gke heroku k8s keycloak kotlin kubernetes postgres springboot2 travis-ci
Last synced: about 1 month ago
JSON representation
a minimalistic WMS system, back-end
- Host: GitHub
- URL: https://github.com/maslick/barkoder
- Owner: maslick
- License: mit
- Created: 2018-12-05T15:21:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-02T19:24:16.000Z (over 6 years ago)
- Last Synced: 2025-04-08T18:49:30.390Z (about 1 year ago)
- Topics: artifactory, barkoder, bintray, gke, heroku, k8s, keycloak, kotlin, kubernetes, postgres, springboot2, travis-ci
- Language: Kotlin
- Homepage:
- Size: 312 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# =barkoder=
a minimalistic WMS system
[](https://travis-ci.org/maslick/barkoder)
[](https://hub.docker.com/r/maslick/barkoder)
[](https://codeclimate.com/github/maslick/barkoder/maintainability)
[](https://codecov.io/gh/maslick/barkoder)
[  ](https://bintray.com/maslick/maven/barkoder/_latestVersion)
## Features
* simple REST API
* OAuth2.0 by Keycloak (optional)
* written in Kotlin
* SpringBoot v2
* Android native [client](https://github.com/maslick/kodermobilj)
* Web [client](https://github.com/maslick/barkoder-ui)
* Heroku deployment
* Docker image on Dockerhub
* Docker-compose configuration
* Openshift deployment
* Kubernetes descriptors
## Installation (local)
```
$ git clone https://github.com/maslick/barkoder.git
$ ./gradlew clean build
```
or simply download the artifact from ``bintray``:
```
$ wget -O barkoder-0.4.jar https://bintray.com/maslick/maven/download_file?file_path=io/maslick/barkoder/0.4/barkoder-0.4.jar
```
## Usage (local)
Create the file ``application.properties`` and put it in the same directory as the jar:
```
# Db
spring.datasource.platform=postgres
spring.datasource.url=jdbc:postgresql://${PGHOST}:5432/${PGDATABASE}?sslmode=disable
spring.datasource.username=${PGUSER}
spring.datasource.password=${PGPASSWORD}
spring.jpa.properties.hibernate.temp.use_jdbc_metadata_defaults=false
spring.jpa.database-platform=org.hibernate.dialect.PostgreSQL9Dialect
spring.datasource.driver-class-name=org.postgresql.Driver
spring.jpa.hibernate.ddl-auto=update
# OAuth2.0
keycloak.auth-server-url=${KCHOST}/auth
keycloak.resource=${CLIENT}
keycloak.realm=${REALM}
keycloak.bearer-only=true
keycloak.ssl-required=external
keycloak.credentials.secret=${CLIENT_SECRET}
keycloak.cors=true
keycloak.enabled=${KC_ENABLED:false}
keycloak.securityConstraints[0].securityCollections[0].name=secured stuff
keycloak.securityConstraints[0].authRoles[0]=${CLIENT_ROLE}
keycloak.securityConstraints[0].securityCollections[0].patterns[0]=/*
```
Run the service:
```
$ java -jar barkoder-0.4.jar
```
## API
* List all Items: ``GET /items``
* Get an Item by its id: ``GET /item/{id}``
* Get an Item by its barcode: ``GET /barcode/{barcode}``
* Add new Item: ``POST /item``
* Add multiple Items: ``POST /items``
* Update an Item: ``PUT /item``
* Delete an Item by its id: ``DELETE /item/{id}``
* Delete an Item by its barcode: ``DELETE /barcode/{barcode}``
For the payload use the ``application/json`` MIME type (UTF-8).
If the REST API is secured with ``Keycloak``, an ``Authorization`` header should be present in each request:
```
"Authorization" : "bearer ${KEYCLOAK_TOKEN}"
```
## Entity
``Item``:
```
{
"id": 1
"title": "Union Lager",
"category": "beer",
"description": "Full flavour, medium bitterness",
"barcode": "5901234123457",
"quantity": 1
}
```
``Response``:
```
{
"status": "OK",
"errorMessage": null
}
```
## Deployments
* [Docker-compose](deployment/compose.md)
* [Heroku](deployment/heroku.md)
* [Openshift](deployment/openshift.md)
* [Terraform](terraform/README.md)
* [Kubernetes](deployment/k8s.md)