Online software documentation management system.

• Git
• Java SE Development Kit 8
• Gradle 6.6
• MySQL 5.7

Once the environment is set up with the required dependencies, you can clone the source code:

$ git clone https://github.com/Ajlag/doku-api

When the cloning completes, you can navigate into the directory where the source code is cloned:

$ cd doku-api

Before building the project, you need to adjust the configuration files' parameters in the src/main/resources/application.yml file:

• development document: Contains development profile parameters (ie. local database connection URL, credentials, etc.).
• test document: Contains testing profile parameters. All tests are executed under this profile.
• release document: Contains release profile parameters.

With the proper profile and configuration parameters adjusted as per the local environment, you can build the application using one of the following commands:

$ gradle clean build                  # Execute all tests and build project

$ gradle clean build -x test          # Build project without executing tests

In case you only want to execute tests:

$ gradle test

After the application has been successfully built, the application's executable JAR will be placed in the build/libs directory of the application directory. Application can be started just like any other JAR, using the following:

$ java -jar build/libs/doku-api-VERSION_TAG.jar