| Status | |
|---|---|
| circleCI |  |
| code coverage |  |
| code quality | |
| latest build |  |
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 agents. An agent is is a person, sensor or entity that can submit incidents in to the system.
API Documentation: https://github.com/asw-i3a/agents-service/wiki/API-Documentation
| Group | Artifact |
|---|---|
| io.github.asw.i3a | agents.service |
- Herminio García González (@herminiogg)
- Jose Emilio Labra Gayo (@labra)
- Jorge Zapatero Sánchez (@JorgeZapa)
- Damián Rubio Cuervo (@DamianRubio)
- Antonio Nicolás Rivero Gómez (@Lan5432)
Contributions to the project are welcomed and encouraged! Please see the Contributing guide.
These instructions give the most direct path to work with this module.
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.
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.
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.
This project uses Jasypt to encrypt the passwords. You don't need to download it as far as its dependency its imported from maven central, but you can check it here.
First create a directory for all of the project sources:
mkdir agents_service
cd agents_service
Cloning repository
git clone https://github.com/asw-i3a/agents-service.git
As the project was created on eclipse this is the best way to build and run the sources. The steps are the following:
- Open Eclipse IDE.
- Select import existing Maven Project.
- Go to
src/main/java/main/Application.java. - Right click over the class and Run as Java Application.
Up to this point the module should be up and running in the address localhost:8080.
Or you can use mvn install to fully build the module.
To run the module you need to set the repository as working directory and run the following statement mvn spring-boot:run.