Merge pull request #30 from datacrop/system

Getting ready for release v0.3.0

Author: AngelaMariaDespotopoulou

CHANGELOG.md

@@ -1,25 +1,71 @@
 # Changes Log
 All notable changes to this project (DataCROP Model Repository) will be documented in this file.
 
+---
+### [Release v0.3.0] - 2022-11-08
+
+#### :chart_with_upwards_trend: Business Goal 
+* Implementation of endpoints pertaining to Iot Systems (Asset Management). Version for MongoDB. ~ [Milestone](https://github.com/datacrop/maize-model-repository/milestone/1)
+
+#### :rocket: Added 
+
+* `model-repository-server`
+  - [#10](https://github.com/datacrop/maize-model-repository/issues/10), [#11](https://github.com/datacrop/maize-model-repository/issues/11), [#13](https://github.com/datacrop/maize-model-repository/issues/13), [#14](https://github.com/datacrop/maize-model-repository/issues/14), [#15](https://github.com/datacrop/maize-model-repository/issues/15), [#16](https://github.com/datacrop/maize-model-repository/issues/16), [#24](https://github.com/datacrop/maize-model-repository/issues/24)
+  Implementation of classes pertaining to IoT Systems and Locations on modules "commons", "mongodb", "persistence", "services" and "api". ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+  - [#17](https://github.com/datacrop/maize-model-repository/issues/17), [#18](https://github.com/datacrop/maize-model-repository/issues/18)
+  Implemented automated tests pertaining to IoT Systems and Locations on modules "mongodb" and "api". ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+  
+  - [#27](https://github.com/datacrop/maize-model-repository/issues/27)  
+  Added Dockerfile and .dockerignorefile to define containerization. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+* `deployment-scripts`
+  - [#28](https://github.com/datacrop/maize-model-repository/issues/28)
+  Created two docker-compose files: one to deploy only the databases for development and one to deploy locally a MongoDB - API pair. (The API is being pulled from DockerHub.) ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+* `documentation`
+  - [#19](https://github.com/datacrop/maize-model-repository/issues/19)
+  Created Postman collection and environment. Exported and placed in documentation file. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+  - [#20](https://github.com/datacrop/maize-model-repository/issues/20)
+  Created API documentation pertaining to IoT Systems and Locations in .docx and .pdf format. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+  - [#21](https://github.com/datacrop/maize-model-repository/issues/21)
+  Configured automatic creation of Swagger UI. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+  - [#23](https://github.com/datacrop/maize-model-repository/issues/23)
+  Generated documentation using the Javadoc tool. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+* `samples`
+  - [#29](https://github.com/datacrop/maize-model-repository/issues/29)
+  Created first request and response sample Systems in .json format. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+#### :pencil2: Updated 
+
+* `quick-dev-tools`
+  - [#28](https://github.com/datacrop/maize-model-repository/issues/28)
+  Renamed to "deployment-scripts". ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
+
+#### :wrench: Fixed 
 ---
 ### [Release v0.2.0] - 2022-10-30
 
 #### :chart_with_upwards_trend: Business Goal 
-* Instantiation of the Spring Boot Project with multiple properties files for different databases. ~ [Milestone 2](https://github.com/datacrop/maize-model-repository/milestone/2)
+* Instantiation of the Spring Boot Project with multiple properties files for different databases. ~ [Milestone](https://github.com/datacrop/maize-model-repository/milestone/2)
 
 #### :rocket: Added 
 
 * `model-repository-server`
   - [#8](https://github.com/datacrop/maize-model-repository/issues/8)
   Instantiated the Spring Boot Project as a Maven Project with six modules: API, services, persistence, mysql, mongo, commons. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
   - [#9](https://github.com/datacrop/maize-model-repository/issues/9)
-Created the following application.properties files: one generic, one for Mongo configurations, one for H2 JPA database and one for MySQL JPA database.
+  Created the following application.properties files: one generic, one for Mongo configurations, one for H2 JPA database and one for MySQL JPA database.
 * `quick-dev-tools\docker-compose.yml`
   - [#9](https://github.com/datacrop/maize-model-repository/issues/9)
   Created docker-compose.yml file for local installation of a MongoDB and a MySQL container for development purposes. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
 
 
-#### :pencil2: Changed 
+#### :pencil2: Updated 
 
 #### :wrench: Fixed 
 ---
@@ -53,7 +99,7 @@ Created the following application.properties files: one generic, one for Mongo c
   Created a documentation file describing the component's purpose, contents and status. ([@AngelaMariaDespotopoulou](https://github.com/AngelaMariaDespotopoulou))
 
 
-#### :pencil2: Changed 
+#### :pencil2: Updated 
 
 #### :wrench: Fixed 
 

README.md

@@ -1,7 +1,7 @@
 # DataCROP Model Repository ~ Maize :corn: (V3.0) 
 Implementation of databases based on the DataCROP Maize :corn: (V3.0) digital models. 
 <p align="center">
-<a href="https://github.com/datacrop/maize-model-repository/releases"><img src="https://img.shields.io/badge/latest%20release-v0.2.0-blueviolet" alt="Release"></a>
+<a href="https://github.com/datacrop/maize-model-repository/releases"><img src="https://img.shields.io/badge/latest%20release-v0.3.0-blueviolet" alt="Release"></a>
 <a href="https://github.com/datacrop/maize-model-repository/blob/main/LICENSE"><img src="https://img.shields.io/github/license/datacrop/maize-model-repository" alt="License"></a>
 </p>
 

deployment-scripts/README.md

@@ -0,0 +1,29 @@
+# DataCROP Model Repository ~ Maize :corn: (V3.0) 
+Implementation of databases based on the DataCROP Maize :corn: (V3.0) digital models. 
+<p align="center">
+<a href="https://github.com/datacrop/maize-model-repository/releases"><img src="https://img.shields.io/badge/latest%20release-v0.3.0-blueviolet" alt="Release"></a>
+<a href="https://github.com/datacrop/maize-model-repository/blob/main/LICENSE"><img src="https://img.shields.io/github/license/datacrop/maize-model-repository" alt="License"></a>
+</p>
+
+<p align="center">
+  <img src="../pictures/release.jpg" width="600px" />
+</p>
+
+## Directory contents
+The present directory contains scripts for easy deployment of components for both development and production environments. Here follows a summary of the current directory's contents:
+* **[docker-compose-api-and-mongo.yml](docker-compose-api-and-mongo.yml)**: this file contains configurations that deploy the Model Repository to be used along with a MongoDB instance.
+* **[docker-compose-databases-only.yml](docker-compose-databases-only.yml)**: this file contains configurations to locally deploy a MongoDB and a MySQL instance for development purposes.
+
+## Deployment using Docker-Compose (example)
+1. Command to **deploy** the stack on localhost:
+> docker-compose -f docker-compose-api-and-mongo.yml -p modelrepo up -d 
+
+2. To test deployment, the Swagger interface must appear here:
+> <a href="" onclick="return false">http://localhost:8087/swagger-ui/index.html#/</a>
+
+3. Command to **undeploy** the stack:
+> docker-compose -f docker-compose-api-and-mongo.yml -p modelrepo down
+
+4. Command to clear the unused images/volumes for **housekeeping** (be <u>sure you really want to</u> before doing this):
+
+> docker system prune -a

deployment-scripts/docker-compose-mongo.yml renamed to deployment-scripts/docker-compose-api-and-mongo.yml

@@ -19,7 +19,7 @@ services:
     restart: on-failure
 
   maize-model-repository:
-    image: 'datacrop/maize-model-repository:0.2.0'
+    image: 'datacrop/maize-model-repository:0.3.0'
     container_name: model-repository
     depends_on:
       - mongo-storage   

deployment-scripts/javadoc.txt

@@ -0,0 +1,17 @@
+# DataCROP Model Repository ~ Maize :corn: (V3.0) 
+Implementation of databases based on the DataCROP Maize :corn: (V3.0) digital models. 
+<p align="center">
+<a href="https://github.com/datacrop/maize-model-repository/releases"><img src="https://img.shields.io/badge/latest%20release-v0.3.0-blueviolet" alt="Release"></a>
+<a href="https://github.com/datacrop/maize-model-repository/blob/main/LICENSE"><img src="https://img.shields.io/github/license/datacrop/maize-model-repository" alt="License"></a>
+</p>
+
+<p align="center">
+  <img src="../pictures/documentation.png" width="500px" />
+</p>
+
+## Documentation
+The present directory contains the documentation of the API exposed by the Model Repository's backend component. Here follows a summary of the directory's contents:
+* **[document](document)**: Documentation of the API endpoints in .docx and .pdf formats.  
+* **[javadocs](javadocs)**: Automatically generated [Java code documentation](https://en.wikipedia.org/wiki/Javadoc) in website format.
+* **[postman](postman)**: Exports of [Postman](https://www.postman.com/) collection (requests and examples) and environment.
+* **[swagger](swagger)**: Export of api-docs.json document for [Swagger](https://swagger.io/) and screenshot of the deployed result.