Royal Rangers [Backend app]

This application provides an API that is used by and Angular application and potentially might be used by an Android app.

Technologies

• Java
• MySQL
• Gradle
• Spring Boot
• Spring Data
• etc...

Installation

Prepare en environment:

Run the next command to download the repository

git clone -b develop https://github.com/royalrangers-ck/rr-api.git

1. Download and install Java from here
2. Download and install MySQL v5.1.* from here
3. Go to application.yml and set appropriate username and password to your mysql database.

Run application

You an run the application from the Intellij Idea or just running the gradlew.bat

Run with gradlew.bat

The next command will download Gradle, all dependencies and run the application

For Windows:

gradlew.bat bootRun

For Ubuntu

gradlew bootRun

Run from Intellij Idea

1. Download and extract Gradle from here. Tell to Intellij Idea where your gradle is located.
2. Open project from Intellij Idea. Download dependencies using Gradle.
3. Right click on Application.java and select Run application

After application is launched, go to localhost:8080 and try it.

Documentation

We're using Swagger as a documenting tool.

After application is started, navigate to http://localhost:8080/api/swagger-ui.html and you'll see the list of available APIs.