Step By Step SonarQube Setup And Run SonarQube Scanner

5. Troubleshoot the server(optional)
   If you face any issue like this, then just click on more info and download the required Java SDK & install on your machine. Close the terminal and open a new terminal. Follow step 4 again and your SonarQube will be up and running.
   
   
   

6. Test SonarQube running server
   
   
   
   
   After step 4, if your terminal shows this output, that means your SonarQube Server is up and running.

Open any browser, add the following address into address bar, and hit Enter.

http://localhost:9000

You should be able to see this kind of output on your browser.

You are all set with your SonarQube Server. Now, it’s time to run the SonarQube Scanner on your code or project.

7. Setup for Sonarqube-Scanner

Go to your project folder which you want to scan.

Create one new file inside your project's root folder path with name “sonar-project”. The extension of the file will be “.properties”.

sonar-project.properties

Add the following basic configurations inside “sonar-project.properties” file.

sonar.projectKey="any unique name"
sonar.projectName="any unique name"
sonar.sourceEncoding=UTF-8
sonar.sources="list of folders which will scan"
sonar.exclusion="list of folders which will exclude from scan"

“sonar.sources” & “sonar.exclusion” property values will be the list of folders or files which you wants to scan or exclude from scan. The list must be separated by comma(,). If you want to include all files or folders, then just mention Dot(.)

Here is the example of my test project.

I want to scan only “src” folder so I have added value “src” in “sonar.sources” property. I want to exclude rest of all the JS & CSS libraries from scanning so I mentioned the list of exclusion folders in “sonar.exclusion” property.

8. Run SonarQube Scanner on your project.
   
   Now, you are all set for your scanning your code. Open “terminal.app” (for other OS Platform “Command prompt”), and from terminal, go to the folder path where your project code resides.

// for example, I kept my test project on this path
cd /Users/apple/Downloads/Test-Project/

Run this command to scan your code.

sonar-scanner // start scann
sonar-scanner -h // to see other commands

Once the scanning ends, it will show you the output of scanning with the path where you can see the scanning details with dashboard data.

If you access this path on a browser, you will see the Dashboard with the scanning result data.

That's it. You got the data regarding your code quality; this data has steps to improve your code, follow it.

Happy coding!!!

If you found this article helpful, please hit the like button and share it with your friends & colleagues. :)