https://github.com/thehyve/whereabouts
Data warehouse Inventory Management System
https://github.com/thehyve/whereabouts
data-warehouse
Last synced: 4 months ago
JSON representation
Data warehouse Inventory Management System
- Host: GitHub
- URL: https://github.com/thehyve/whereabouts
- Owner: thehyve
- License: mit
- Created: 2019-05-27T14:39:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T18:51:47.000Z (over 1 year ago)
- Last Synced: 2024-04-09T12:09:58.298Z (over 1 year ago)
- Topics: data-warehouse
- Language: Java
- Size: 2.31 MB
- Stars: 2
- Watchers: 7
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# whereabouts
[](https://travis-ci.org/thehyve/whereabouts/branches)
[](https://codecov.io/gh/thehyve/whereabouts)
[](https://codebeat.co/projects/github-com-thehyve-whereabouts-master)
[](https://snyk.io//test/github/thehyve/whereabouts?targetFile=pom.xml)
Data warehouse Inventory Management System that maintains a catalogue of data warehouse instances,
with information about how they were created (to enable restoring a similar instance)
and how to connect to them (required for the data loading and slicing services).
## Run, test, deploy
Run the application and its database using [docker](./docker/README.md) or follow the instruction below.
### Configure PostgreSQL database
```bash
sudo -u postgres psql
```
```bash
create user wa with password 'wa';
create database whereabouts;
grant all privileges on database whereabouts to wa;
```
Required tables will be created on application startup using Liquibase.
This behaviour can be disabled by this setting:
```
spring.liquibase.enabled=false
```
### Configure Keycloak
Whereabouts uses Keycloak as an identity provider.
The following settings need to be configured before running the application.
| yaml key | description |
|-----------|-------------|
| `keycloak.auth-server-url` | keycloak url that used. e.g. `https://keycloak.example.com/auth` |
| `keycloak.realm` | keycloak realm. |
| `keycloak.resource` | keycloak client id. |
There are 3 Keycloak client roles that need to be added for users to enable the access to all endpoints:
- read-instances,
- create-instances,
- change-instances;
See [swagger documentation](/src/main/resources/public/swagger.yaml) for more details.
### Run
Make sure you have Maven installed.
```bash
# run the application
mvn spring-boot:run
```
There should now be an application running at [http://localhost:8086/](http://localhost:8086/).
### Package
The package depends on Java 11.
```bash
# create a jar package
mvn clean package
```
There should now be a `.jar`-file in `target/whereabouts-.jar`.
```bash
# run the packaged application
java -jar target/whereabouts-.jar
```
### Tests
Run all tests. The test will use the configuration from `./src/test/resource/application.yml` file.
```bash
mvn test
```
## Acknowledgement
This project was funded by the German Ministry of Education and Research (BMBF) as part of the project
DIFUTURE - Data Integration for Future Medicine within the German Medical Informatics Initiative (grant no. 01ZZ1804D).
## License
Copyright (c) 2019 The Hyve B.V.
The Data warehouse Inventory Management System is licensed under the MIT License. See the file [LICENSE](LICENSE).