diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e24704cee..9acf7a2f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,17 +5,17 @@ You can run from source code as follows: 1. Install Java and Docker -2. Checkout the source using ```git clone https://github.com/molgenis/molgenis-service-armadillo.git``` -3. Optionally copy ```application.template.yml``` to ```application.yml``` to change settings (will be .gitignored) -4. Compile and execute the code using ```./gradlew run``` +2. Checkout the source using `git clone https://github.com/molgenis/molgenis-service-armadillo.git` +3. Optionally copy `application.template.yml` to `application.yml` to change settings (will be .gitignored) +4. Compile and execute the code using `./gradlew run` Note: contact MOLGENIS team if you want to contribute and need a testing OIDC config that you can run against localhost. # Developing Armadillo We use gradle to build: -* run using ```./gradlew run``` -* run tests using ```./gradlew test``` +* run using `./gradlew run` +* run tests using `./gradlew test` We use intellij to develop * To run or debug in intellij, right click on armadillo/src/main/java/org.molgenis.armdadillo/ArmadilloServiceAppliction and choose 'Run/Debug Armadillo...' @@ -23,6 +23,31 @@ We use intellij to develop We have a swagger-ui to quickly see and test available web services at http://localhost:8080/swagger-ui/ +## Components + +We have several components + +- [Armadillo](./armadillo/src/) source +- [UI](./ui/README.md) readme +- [R](./r/) java integration source +- [docker builds](./docker/) source +- [scripts](./scripts/README.md) migration readme + - [install](./scripts/install/README.md) readme + - [release](./scripts/release/) source + - [ops](./scripts/ops/README.md) readme + +## Releasing + +We release through [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) which autoincrement using [Semantic versioning](https://semver.org/). + +Use `./gradlew nyxMake` to see what is build in [build/distributions](./build/distributions/). + +List messages to see usage of conventional commits from the past. + +```sh +git log --pretty=format:"%s" | cut -c -20 +``` + ## Continuous integration - we test on each PR and merges on master diff --git a/ui/README.md b/ui/README.md index dae52a4df..bf314d7b1 100644 --- a/ui/README.md +++ b/ui/README.md @@ -1,4 +1,17 @@ -# Vue 3 + Vite +# Armadillo UI + +## Test as a UI developer + +From the terminal: +- `cd ui/` +- make sure you have `yarn` installed. +- `yarn test --watch` + +Do your develop stuff and watch your test fail or succeed on the go. That is: +- change files in `src/**` +- change files in `tests/unit/**` + +## How this project was generated This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `