Skip to content

Commit c4b57c1

Browse files
committed
Update documentation
1 parent 69e3d6c commit c4b57c1

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Contributing Guide
2-
This project is built on top of [Dropwizard](http://dropwizard.io/). If you're unfamiliar with that I suggest you spend 30min to go through its excellent Getting Started tutorial. You will like what you see, I promise.
2+
This project is built with [Quarkus](https://quarkus.io) on Kotlin.
3+
If you're unfamiliar with that I suggest you spend 30min to go through its excellent Getting Started tutorial.
4+
You will like what you see, I promise.
35

4-
Of course you have to have an up-to-data JDK and Maven installed but if you've come this far I assume you already know that.
6+
You have to have JDK 17+ and Maven installed, but if you've come this far, I assume you already know that.
57

68
## Development environment setup
79
- `git clone https://github.com/marcelstoer/open-data-smn.git`
810
- `cd open-data-smn/`
9-
- `mvn package`
10-
- `java -jar target/open-data-smn-1.5.1-SNAPSHOT.jar server open-data-smn-dev.yml` <- adjust the version!
11-
- [http://localhost:4711/swagger](http://localhost:4711/swagger)
11+
- `mvn quarkus:dev`
12+
- [http://localhost:8080](http://localhost:8080)
1213

1314
## Commit messages
1415

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/marcelstoer/open-data-smn?label=docker%20image)](https://hub.docker.com/r/marcelstoer/open-data-smn)
55
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/marcelstoer/open-data-smn/blob/master/LICENSE)
66
[![CI with Maven](https://github.com/marcelstoer/open-data-smn/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/marcelstoer/open-data-smn/actions/workflows/maven.yml)
7-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.frightanic%3Aopen-data-smn&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=com.frightanic%3Aopen-data-smn)
7+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=marcelstoer_open-data-smn&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=marcelstoer_open-data-smn)
88

99
OpenData SMN is a simple REST API for [SwissMetNet data](http://www.meteoschweiz.admin.ch/home/mess-und-prognosesysteme/bodenstationen/automatisches-messnetz.html).
1010
It's developed in the open supporting the [OpenData.ch](http://opendata.ch/) initiative.

0 commit comments

Comments
 (0)