Skip to content

Commit b089f2e

Browse files
authored
add doc for spring-cli project creation (#908)
Signed-off-by: Mark Nelson <mark.x.nelson@oracle.com>
1 parent b57057c commit b089f2e

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

docs-source/spring/content/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Developers also have access to development or build time services and libraries
4747

4848
- A command-line interface [(CLI)](development/cli/) to manage service deployment and configuration, including database schema management.
4949
- [Visual Studio Code (VS Code) plugin](platform/vscode-plugin/) to manage service deployment and configuration.
50+
- [Spring CLI](https://spring.io/projects/spring-cli) support for project creation.
5051
- Spring Data (Java Persistence API (JPA) and Oracle JDBC) to access Oracle Database.
5152
- Oracle Java Database Connectivity (Oracle JDBC) drivers.
5253
- [Spring Cloud Config client](platform/config/).

docs-source/spring/content/development/setup.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The following tools are recommended for a development environment:
1717
- Integrated Development Environment, for example Visual Studio Code
1818
- Java Development Kit, for example Oracle, OpenJDK, or GraalVM
1919
- Maven or Gradle for build and testing automation
20+
- Spring CLI (optional) for project creation
2021

2122
If you wish to test locally or offline, then the following additional tools are recommended:
2223

@@ -108,6 +109,26 @@ JVM: 17.0.3 (Oracle Corporation 17.0.3+8-LTS-111)
108109
OS: Linux 5.10.102.1-microsoft-standard-WSL2 amd64
109110
```
110111

112+
## Spring CLI for project creation
113+
114+
You can create projects with [Spring CLI](https://spring.io/projects/spring-cli). To use this
115+
feature, install Spring CLI following the instructions provided in that repository, and then
116+
import the Oracle Project Catalog as follows:
117+
118+
```bash
119+
spring project catalog add --name oracle --url https://github.com/oracle/spring-cloud-oci/tree/obaas-starter/database/spring-cli/catalog
120+
```
121+
122+
To create a new project, for example called `test2` with specific Maven group and artifact IDs,
123+
use a command similar to this, substituting your desired coordinates:
124+
125+
```bash
126+
spring boot new --name test2 --from obaas --group-id com.example --artifact-id test2 --version 0.0.1
127+
```
128+
129+
Review the `README` file in the created project for details of next steps.
130+
131+
111132
## Oracle Database in a container for local testing
112133

113134
If you want to run an instance of Oracle Database locally for development and testing, then Oracle recommends Oracle Database 23c Free. You can start the database in a container with this

0 commit comments

Comments
 (0)