Skip to content

balajeetm/t-nut

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

T-NUTs

Technical-Nuts Hi Unjars (short for unjargoners),
Welcome aboard!
Hope you are coming over from one of my technical-nuts in my blog.

For people who are what a technical nut is..
Well, a t-nut is a short hand for a technical-nut. Any exiciting problem which requires a logical approach.
For the details jump over to t-nut and cracking a t-nut

What's this repo?

This repo hosts the solutions for few programming t-nuts we encounter and address in my blog
The solutions hosted in the repo are shown below. Please hop on to the below links for details on their usage

How to use this repo

This repo contains a maven based spring boot and json-mystique oriented web application with embedded servlet container.

All you need to do is pull the project into to your IDE (Eclipse, STS, IntelliJ) and you are good to go.
I'll explain how to get rolling if you use STS as your IDE

Steps to get rolling

  • Import the Project

Once you open STS, and choose a workspace, you should see package explorer as your left pane as shown below.
If you do not see package explorer, just choose "Window" on the STS menu and say "Show View" and choose Package Explorer. Package Explorer

On the package explorer, right click and say "Import"
Import Project

Alternatively, you can say "File"->"Import" directly in your STS menu options.

Remember to import the project as a maven project
Import Maven Project

  • Run the application using Spring Boot DashBoard
    Once the project the imported, choose the spring boot dashboard as shown below and click on run as shown below. The T-Nut webapplication will run by default on port 7189. If that doesn't work for you, configure it to an appropriate port by updating the application.yml's server.port property

Run Application

Alternatively, you can build the jar using "mvn clean package" and run the built jar, using "java -jar target/tnut.jar" on the terminal

  • Launch Swagger UI
    The T-Nut web application comes with swagger support.
    Swagger is the most popular API framework for documenting ReST Apis.
    The project uses spring-fox, to generate runtime documentation of its ReST APIs and also help you to execute the apis on the fly.

The application's swagger apis are available by default in the below location http://localhost:7189/swagger-ui.html

Once you go to the link, T-Nut application's swagger page will look like the below: T-Nut Swagger

  • Execute the APIs and test the flows Once the swagger is launched, each T-Nut is separated as different items in the accordion with different apis representing different solutions for the same T-Nut.

Execute the APIs and have fun unjorgoning

Cheers

Releases

No releases published

Packages

No packages published

Languages