Skip to content

Commit fede263

Browse files
committed
updated readme
1 parent 5b919a0 commit fede263

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@ Often, the first step developers take after creating their database is to create
77
1. How to create, read, update, and delete documents using Key-Value[ operations](https://docs.couchbase.com/java-sdk/current/howtos/kv-operations.html) (KV operations). KV operations are unique to Couchbase and provide super fast (think microseconds) queries.
88
2. How to write simple parametrized [N1QL queries](https://docs.couchbase.com/java-sdk/current/howtos/n1ql-queries-with-sdk.html) using the built-in travel-sample bucket.
99

10-
Full documentation for the tutorial can be found on the [Couchbase Developer Portal](https://developer.couchbase.com/tutorial-quickstart-spring-boot-java/).
11-
12-
If you are looking for a quick start using [Micronaut](https://micronaut.io/)](https://micronaut.io/), you can find it in this [repo](https://github.com/couchbase-examples/java-quickstart-micronaut).
10+
Full documentation for the tutorial can be found on the [Couchbase Developer Portal](https://developer.couchbase.com/tutorial-quickstart-java-springboot/).
1311

1412
## Prerequisites
1513

1614
To run this prebuilt project, you will need:
1715

1816
- [Couchbase Capella](https://www.couchbase.com/products/capella/) cluster with [travel-sample](https://docs.couchbase.com/java-sdk/current/ref/travel-app-data-model.html) bucket loaded.
1917
- To run this tutorial using a self-managed Couchbase cluster, please refer to the [appendix](#running-self-managed-couchbase-cluster).
20-
- [Java](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html) 11 or higher installed
21-
- Ensure that the Java version is compatible with the Couchbase SDK.
18+
- [Java](https://docs.couchbase.com/java-sdk/current/project-docs/compatibility.html#jdk-compat)
19+
- Ensure that the Java version is compatible with the Couchbase SDK. (Please check the link for compatibility)
2220
- Loading Travel Sample Bucket
2321
If travel-sample is not loaded in your Capella cluster, you can load it by following the instructions for your Capella Cluster:
2422
- [Load travel-sample bucket in Couchbase Capella](https://docs.couchbase.com/cloud/clusters/data-service/import-data-documents.html#import-sample-data)
23+
- Maven
24+
- [Install Maven](https://maven.apache.org/install.html)
2525

2626
## App Setup
2727

@@ -30,7 +30,7 @@ We will walk through the different steps required to get the application running
3030
### Cloning Repo
3131

3232
```shell
33-
git clone https://github.com/couchbase-examples/java-springboot-quickstart
33+
git clone https://github.com/couchbase-examples/java-springboot-quickstart.git
3434
```
3535

3636
### Install Dependencies
@@ -64,7 +64,8 @@ spring.couchbase.bucket.user=DB_USERNAME
6464
spring.couchbase.bucket.password=DB_PASSWORD
6565
```
6666

67-
Instead of the hash symbols, you need to add the values for the Couchbase connection.
67+
Instead of the DB_CONN_STR, DB_USERNAME and DB_PASSWORD
68+
, you need to add the values for the Couchbase connection.
6869

6970
> Note: The connection string expects the `couchbases://` or `couchbase://` part.
7071
@@ -129,11 +130,10 @@ For this quickstart, we use three collections, `airport`, `airline` and `routes`
129130

130131
If you would like to add another entity to the APIs, these are the steps to follow:
131132

132-
- Create the new entity (collection) in the Couchbase bucket. You can create the collection using the [SDK](https://docs.couchbase.com/sdk-api/couchbase-java-client-3.5.2/com/couchbase/client/java/Collection.html#createScope-java.lang.String-) or via the [Couchbase Server interface](https://docs.couchbase.com/cloud/n1ql/n1ql-language-reference/createcollection.html).
133+
- Create the new entity (collection) in the Couchbase bucket. You can create the collection using the [SDK](https://docs.couchbase.com/cloud/management-api-reference/index.html) or via the [Couchbase Server interface](https://docs.couchbase.com/cloud/n1ql/n1ql-language-reference/createcollection.html).
133134
- Define the routes in a new file in the `controllers` folder similar to the existing routes like `AirportController.java`.
134135
- Define the service in a new file in the `services` folder similar to the existing services like `AirportService.java`. You'll have to implement the service interface `AirportServiceImpl.java`.
135136
- Define the repository in a new file in the `repositories` folder similar to the existing repositories like `AirportRepository.java`. You'll have to implement the repository interface `AirportRepositoryImpl.java`.
136-
- Add the new routes to the application in `Application.java`.
137137

138138
### Running Self-Managed Couchbase Cluster
139139

0 commit comments

Comments
 (0)