Skip to content

asw-i3a/incidents-service

 
 

Repository files navigation

I3A Incidents Service

Status
travis ci CircleCI
code coverage codecov
code quality Codacy Badge
latest build Docker Badge

Welcome to our agents service

This micro-servide forms part of platform called GestUsers, if you don't know about it, we encourage you to see this other repo first.

Here your will find the source code of a micro-service dedicated to write / read operations in a database of incidents. An incident is is a representation of a notification about an event that contains some important information about it.

API Documentation: https://github.com/asw-i3a/project-documentation/tree/master/inci_api_doc

Package

Group Artifact
io.github.asw.i3a incidents.service

Authors

Contributing to this service

Contributions to the project are welcomed and encouraged! Please see the Contributing guide.

System requirements

As the project is developed in java macOS, Windows and Linux distributions are natively supported. Of course you will need the latest JDK available. Also, depending on where are you going to run the database, you will need internet connection or MongoDB installed and running on your machine.

Java Development Kit (JDK)

A Java Development Kit (JDK) is a program development environment for writing Java applets and applications. It consists of a runtime environment that "sits on top" of the operating system layer as well as the tools and programming that developers need to compile, debug, and run applets and applications written in the Java programming language.

If you do not has the latest stable version download you can download it here.

MongoDB

This project uses MongoDB as the database. You can check how to use it on MongoDB install. By defatult a dummy server is up and running, it´s configured at the file applications.properties. Change this configuration as needed, should not interfeer with the module itself.

Building the project

It is as simple as running mvn install. Or if you want to run it you can use mvn mvn spring-boot:run.

About

A micro-service for managing incidents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%