Skip to content
Karthik Pillai edited this page Sep 29, 2021 · 12 revisions

How to Set Up?

1. Cloning the repository

Clone this repository using git clone.

git clone https://github.com/NeoSOFT-Technologies/rest-java-spring-boot.git

2. Install dependencies

This project uses Gradle for dependency management. After cloning, refresh the Gradle for installing all the required dependencies.

3. Setting up database connection

  • Set up MySQL database on your local machine.
  • Go to application-dev.yml (rest-java-spring-boot\src\main\resources\config\application-dev.yml) and change the port number on which MySQL database is running. In the below example, MySQL is running on port 3306.

url: jdbc:mysql://localhost:3306/basicSample?allowPublicKeyRetrieval=true&....&createDatabaseIfNotExist=true

  • Add database credentials in application-dev.yml. The example shown below shows username as "root" and password as "admin"

username: root

password: admin

4. Running the sample app

  • Run the BasicSampleApp.java (rest-java-spring-boot\src\main\java\com\springboot\restBasicSampleApp.java)
  • You can access the app at http://localhost:8080

5. Swagger endpoints

Access the available endpoints at

http://localhost:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

Set-up.compressed.mp4