From cd77081009a31a9e480a04dab1404c92d42d3ff5 Mon Sep 17 00:00:00 2001 From: Fionn Date: Fri, 10 Mar 2023 21:41:48 +0100 Subject: [PATCH] fix name, remove useless stuff from docker-compose, readme --- .drone.yml | 4 ++-- README.md | 21 ++++++++++++++++----- docker-compose.yml | 3 --- 3 files changed, 18 insertions(+), 10 deletions(-) diff --git a/.drone.yml b/.drone.yml index 8f1bfb8..602634b 100644 --- a/.drone.yml +++ b/.drone.yml @@ -8,7 +8,7 @@ steps: settings: dockerfile: Dockerfile registry: git.fsisp.de - repo: git.fsisp.de/fionn/isasure-wx + repo: git.fsisp.de/fionn/iassure-wx username: from_secret: reg_username password: @@ -33,7 +33,7 @@ steps: settings: dockerfile: Dockerfile registry: git.fsisp.de - repo: git.fsisp.de/fionn/isasure-wx + repo: git.fsisp.de/fionn/iassure-wx username: from_secret: reg_username password: diff --git a/README.md b/README.md index 0f8bd64..af9019c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ -# TypeScript Project Template +# IASsure-WX -## preparation +## idea -```sh -npm install -g eslint eslint-config-airbnb-typescript eslint-plugin-import eslint-plugin-n eslint-plugin-promise -``` \ No newline at end of file +This service is designed to gather weather data to be used by [IASsure](https://github.com/MorpheusXAUT/IASsure) by [MorpheusXAT](https://github.com/MorpheusXAUT). It is uses the [Open-Meteo.com](https://open-meteo.com)-API to gather the necessary data to provide to the plugin. + +## Installation/Deployment + +IASsure-WX can be installed using docker. The image is available at `git.fsisp.de/fionn/iassure`. + +Tags: + - `latest` - The newest recommended build, built from `main` + - `dev` - The newest development/staging build, built from `develop` + - Other than those tags, every image is tagged with the git commit id + +## Configuration + +IASsure-WX can be configured using the `wx-config.json`-file. For now it contains test data but will include production data for at least the Langen FIR. It necessary, another file can be mounted on top of it (`/opt/wx-config.json`). You may also choose to make the necessary changes to the file in this repository. The file is documented in the schema definition file (`wx-config.schema.json`). diff --git a/docker-compose.yml b/docker-compose.yml index 75938ec..4fc748d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -13,6 +13,3 @@ services: - '9229:9229/tcp' volumes: - .:/opt:delegated - environment: - - MONGO_URI - - PORT=3030 \ No newline at end of file