vishal-jangid02 / cubereum Goto Github PK

#Spring Boot Application/Cubereum

• Maven - Dependency Management
• JDK - Java™ Platform, Standard Edition Development Kit
• Spring Boot - Framework to ease the bootstrapping and development of new Spring Applications
• MySQL - Open-Source Relational Database Management System

• Postman - API Development Environment (Testing Docmentation)

• RESTful Web Service (CRUD)
• MSYSQL (RDBMS)
• JUnit Test

There are several ways to run a Spring Boot application on your local machine. One way is to execute the main method in the com.Cubereum.CubereumApplication class from your IDE.

• Download the zip.
• Unzip the zip file (if you downloaded one)
• Open Command Prompt and Change directory (cd) to folder containing pom.xml
• Open Eclipse
  • File -> Import -> Existing Maven Project -> Navigate to the folder where you unzipped the zip
  • Select the project
• Choose the Spring Boot Application file (search for @SpringBootApplication)
• Right Click on the file and Run as Java Application

Alternatively you can use the Spring Boot Maven plugin like so:

mvn spring-boot:run

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

Automated dependency updates done via Dependabot

To monitor and manage your application

• Postman Collection - online, with code auto-generated snippets in cURL, jQuery, Ruby,Python Requests, Node, PHP and Go programming languages
• Postman Collection - offline

The project (a.k.a. project directory) has a particular directory structure. A representative project is shown below:

.
├── Spring Elements
├── src
│   └── main
│       └── java
│           ├── com.Cubereum
│           ├── com.Cubereum.Controller
│           ├── com.Cubereum.Models
│           ├── com.Cubereum.Repositary
│           ├── com.Cubereum.Service
│           └── com.Cubereum.ServiceImp
├── src
│   └── main
│       └── resources
│           └── static
│           ├── templates
│           ├── application.properties

├── src
│   └── test
│       └── java
├── JRE System Library
├── Maven Dependencies
├── bin
├── logs
│   └── application.log
├── src
├── target
│   └──application-0.0.1-SNAPSHOT
├── mvnw
├── mvnw.cmd
├── pom.xml
└── README.md

• models — to hold our entities;

• repositories — to communicate with the database;

• services — to hold our business logic;

• controllers — to listen to the client;

• resources/ - Contains all the static resources, templates and property files.

• resources/static - contains static resources such as css, js and images.

• resources/templates - contains server-side templates which are rendered by Spring.

• resources/application.properties - It contains application-wide properties. Spring reads the properties defined in this file to configure your application. You can define server’s default port, server’s context path, database URLs etc, in this file.

• test/ - contains unit and integration tests

• pom.xml - contains all the project dependencies

• My API Lifecycle Checklist and Scorecard
• HTTP Status Codes
• Common application properties