You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-3Lines changed: 18 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Often, the first step developers take after creating their database is to create
7
7
- How to create, read, update, and delete documents using Key-value operations (KV operations). Key-value operations are unique to Couchbase and provide super-fast (think microseconds) queries.
8
8
- How to write simple parameterized SQL++ queries using the built-in travel-sample bucket.
9
9
10
-
You can find the full documentation for the tutorial on the Couchbase Developer Portal.
10
+
You can find the full documentation for the tutorial on the [Couchbase Developer Portal](https://www.couchbase.com/developers)
11
11
12
12
## Prerequisites
13
13
@@ -29,17 +29,21 @@ If travel-sample is not loaded in your Capella cluster, you can load it by follo
29
29
We will walk through the different steps required to get the application running.
Note: The connection string expects the couchbases:// or couchbase:// part.
59
64
60
65
## Running The Application
61
66
62
67
### Directly on machine
68
+
63
69
At this point, we have installed the dependencies, loaded the travel-sample data and configured the application with the credentials. The application is now ready and you can run it.
64
70
65
-
The application will run on a port specified by Rails. You can find the port in the terminal after running the application. You will find the Swagger documentation at [http://localhost:3000/api-doc](http://localhost:3000/api-doc) of the API if you go to the URL in your browser.
71
+
The application will run on a port specified by Rails. You can find the port in the terminal after running the application. You will find the Swagger documentation at [http://localhost:3000/api-docs](http://localhost:3000/api-docs) of the API if you go to the URL in your browser.
> Note: The dev.env.example file in the root folder has the connection information to connect to your Capella cluster. Create a copy of dev.env.example file and rename it to dev.env and add the values for the Couchbase connection.
80
92
81
93
## Verifying the Application
94
+
82
95
Once the application starts, you can see the details of the application on the terminal.
83
96
84
97
Show Image
@@ -88,6 +101,7 @@ The application will run on the port specified by Rails on your local machine (e
88
101
Show Image
89
102
90
103
## Running The Tests
104
+
91
105
Create a copy of dev.env.example file and rename it to dev.env and add the values for the Couchbase connection.
@@ -144,4 +160,3 @@ Execution: Once you've inputted all the necessary parameters, you can click the
144
160
### Models
145
161
146
162
Swagger documents the structure of request and response bodies using models. These models define the expected data structure using JSON schema and are extremely helpful in understanding what data to send and expect.
0 commit comments