/mms

Primary LanguageJavaApache License 2.0Apache-2.0

MMS Structured Data Version Control

Language grade: Java

The MMS SDVC is a collection of modules built on top of the Spring Framework and is a part of Open-MBEE. For more information about Open-MBEE, visit the Open-MBEE Website

Quick Start

Docker

Installation instructions are found here: Docker documentation

  1. Copy the example properties file in example/src/main/resources/ as application.properties
  2. In the command line, run docker-compose up --build to create and start all the services from the configuration.
  3. Swagger ui at http://localhost:8080/v3/swagger-ui.html
  4. Use the command docker-compose down to stop any containers from running and to remove the containers, networks, and images created by the docker-compose up command. This command should always be done before any new attempts to restart the services from the configuration.

Developer Setup for example project

Docker

We suggest using Docker to set up PostgreSQL and Elasticsearch. Installation instructions are found here: Docker documentation

Java SE Development Kit 11

Installation instructions: JDK-11 download

Postgresql

Install postgres (PostgreSQL) 9.6, instructions for Docker: PostgreSQL with Docker

docker run -d -e POSTGRES_PASSWORD=test1234 -e POSTGRES_USER=mmsuser -e POSTGRES_DB=mms -p 5432:5432 postgres:9-alpine

or Mysql

5.7 Mysql Docker

docker run -d -e MYSQL_ROOT_PASSWORD=test1234 -e MYSQL_DATABASE=mms -p 3306:3306 mysql:5.7

Elasticsearch

Install Elasticsearch 7.1. If you use Docker instructions are available here: Setting up Elasticsearch with Docker

docker run -d -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:7.1.1

IntelliJ IDEA

  1. Import Gradle Project to IntelliJ IDEA
  2. Ensure that you select JDK 10 or above and search recursively for projects.
  3. The example subproject will show you how to include the different modules to run as a Spring Boot application.

Gradle

A gradle wrapper is included in the root of this repository and can be called from the command line with ./gradlew [command].

The Example Sub Project:

  1. Copy the example properties file in example/src/main/resources/ as application.properties
  2. Change values for all the appropriate properties. The example file holds sane values for most properties.
  3. Setup Run and Debug configurations. The command line run command is ./gradlew bootRun
  4. Swagger ui at http://localhost:8080/v3/swagger-ui.html

Running tests

See README in /example

Built With

Contributing

To learn how you can get involved in a variety of ways, please see Contributing to OpenMBEE.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details

Structure of Modules

TBA