bptlab/argos-backend repository overview

⁠Argos Backend

⁠Prerequisites

• MySQL/MariaDB database
• Java 8 (tested with jdk_1.8.0_31 and above)
• Maven 3 (tested with Maven 3.2.5 and above)
• git
• Docker

⁠Local installation

1. Clone the git repo at https://github.com/bptlab/argos-backend.git⁠.
2. Copy and rename the template property file in src/main/resources to argos-backend.properties and change the values as required in your environment.
3. Execute the command mvn install (mvn clean install if you want to delete your old jar file, mvn install -DskipTests if you want to skip the tests). This will compile the project into a jar file in the target folder.
4. execute java -jar target\argos-backend.jar
5. If asked, allow app to pass firewall

⁠Recommended development environment

• IntelliJ IDE
  • SonarLint-Plugin (to use the project specific Lint rules)
  • Configured database connection in IntelliJ
• Database and other applications server
  • Tool by Johannes Schneider (Hannes01071995) -- very lightweight, but Windows only
  • Xampp -- for beginners
  • Docker (see below)

⁠Build Process

We integrated Travis CI⁠ as a continuous integration tool. It builds the project after every commit, sends a sonarLint diagnose to the Sonarqube server at the chair and executes all tests.

⁠Deployment Process

Please see the Installation Guide⁠ for explanations.

⁠Troubleshooting

1. Can't access the database although MySQL/MariaDB server is running on the correct port and server?

   • Make sure that your user has all the rights that he needs for the intended operation.

2. Server doesn't start?

   • Make sure the database is running and accessible from your machine.

3. Can't reach your server via HTTP?

   • Make sure the sure is running.
   • Make sure that the used port is exposed on your firewall.