diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md index 99f5e57f..a3beecae 100644 --- a/docs/configuration-guide.md +++ b/docs/configuration-guide.md @@ -1,6 +1,6 @@ # Configuration Guide -This document will detail how to set up the application locally. +This document will detail how to configure a MySQL database. ### Create a new database using Docker ```bash @@ -32,6 +32,9 @@ docker exec -i mysql-rvf mysql -u root -p$MYSQL_ROOT_PASSWORD -e "GRANT ALL PRIV ``` +### Create a new database using source +Alternatively, follow the steps described on [this page](https://dev.mysql.com/doc/refman/8.0/en/installing.html) to install and configure MySQL 8. + If the MySQL database has been set up outside of Docker, the command to update the user's privileges will still need run: diff --git a/docs/getting-started.md b/docs/getting-started.md index 53285dab..e5fea73a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,30 +1,34 @@ # Getting started + +This document will detail how to get started. + ## Prerequisites - Java 17 - Maven 3 -## Setup -### Install Mysql 8.0 -RVF requires a local MySQL database to be available. -#### Download and install [MySQL 8.0](https://dev.mysql.com/doc/refman/8.0/en/installing.html) -#### Or use brew on macOS -```bash -brew install mysql@8.0 -``` +## Dependencies +- MySQL 8.0 +- Assertions + +#### MySQL 8.0 +Install and configure a MySQL database [as described here](configuration-guide.md). -Following [this](configuration-guide.md) to set up the database and user. +#### Assertions +Install and configure the snomed-release-validation-assertions repository [as described here](importing-assertions.md). -### Build RVF +## Running +Once the prerequisites & dependencies have been configured, simply build & run the application. +#### From source code ```bash -mvn clean install +mvn clean package ``` -### Import assertions -[Follow instructions here](importing-assertions.md). - -### Start RVF application - ```bash java -Xms1024m -Xmx8g -Daws.region=us-east-1 -jar target/release-validation-framework*.jar --server.port=8081 --server.servlet.context-path=/api +``` + +#### From Docker +```bash +docker-compose up -d ``` \ No newline at end of file diff --git a/docs/importing-assertions.md b/docs/importing-assertions.md index 781835af..ac9c0691 100644 --- a/docs/importing-assertions.md +++ b/docs/importing-assertions.md @@ -1,3 +1,7 @@ +# Importing Assertions + +This document will detail how to install & configure assertions. + # Importing SNOMED Release Validation Assertions RVF assertions are in github [snomed-release-validation-assertions](https://github.com/IHTSDO/snomed-release-validation-assertions)