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
Update Ruby Couchbase ORM quickstart tutorial to correct directory name, install additional gem, and reflect port change to 3000 for application and Swagger documentation access.
The dependencies for the application are specified in the `Gemfile` file in the source folder. Dependencies can be installed through `bundler` the default package manager for Ruby.
61
61
62
62
```shell
63
-
cd ruby-on-rails-quickstart
63
+
cd ruby-couchbase-orm-quickstart
64
64
gem install bundler
65
65
bundle install
66
66
```
@@ -73,6 +73,7 @@ gem install rspec
73
73
gem install rubocop
74
74
gem install rswag
75
75
gem install couchbase
76
+
gem install couchbase-orm
76
77
```
77
78
78
79
> Refer to the [instructions in the SDK](https://github.com/couchbase/couchbase-ruby-client#installation) for more info. -->
@@ -108,14 +109,14 @@ To use Couchbase ORM in your Ruby application, you need to configure the connect
108
109
109
110
Replace the values for `connection_string`, `bucket`, `username`, and `password` with your actual Couchbase Server connection details.
110
111
111
-
Couchbase ORM will automatically load the configuration based on the current Rails environment.
112
+
CouchbaseOrm will automatically load the configuration based on the current Rails environment.
112
113
113
114
2. **Non-Rails Applications**:
114
115
115
116
For non-Rails applications, you can configure the connection settings programmatically. Add the following code to your application's initialization file or before you start using Couchbase ORM:
@@ -131,9 +132,9 @@ To use Couchbase ORM in your Ruby application, you need to configure the connect
131
132
132
133
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.
133
134
134
-
The application will run on port 8080 of your local machine (http://localhost:8080). You will find the Swagger documentation of the API which you can use to try the API endpoints.
135
+
The application will run on port 3000 of your local machine (http://localhost:3000). You will find the Swagger documentation of the API which you can use to try the API endpoints.
135
136
136
-
The Swagger Page will be available at [http://localhost:8080/api-docs](http://localhost:8080/api-docs).
137
+
The Swagger Page will be available at http://localhost:3000/api-docs.
137
138
138
139
```shell
139
140
rails s
@@ -146,7 +147,6 @@ If you prefer to run this quick start using Docker, we have provided the Dockerf
docker run --env-file dev.env -p 3000:3000 ruby-couchbase-orm-quickstart
157
157
```
158
158
159
-
> Note: The `.env` file has the connection information to connect to your Capella cluster. With the `--env-file`, docker will inject those environment variables to the container.
159
+
> Note: This app reads Couchbase connection settings from `config/couchbase.yml`. Ensure this file is included in the image (COPY) or mount it into the container at runtime.
160
160
161
-
Once the app is up and running, you can launch your browser and go to the [Swagger documentation](https://localhost:8080/) to test the APIs.
161
+
Once the app is up and running, open http://localhost:3000/api-docs to test the APIs.
162
162
163
163
### Verifying the Application
164
164
165
165
Once the application starts, you can see the details of the application on the logs.
166
166
167
167

168
168
169
-
The application will run on port 8080 of your local machine (http://localhost:8080). You will find the interactive Swagger documentation of the API if you go to the URL in your browser. Swagger documentation is used in this demo to showcase the different API end points and how they can be invoked. More details on the Swagger documentation can be found in the [appendix](#swagger-documentation).
169
+
The application will run on port 3000 of your local machine (http://localhost:3000). You will find the interactive Swagger documentation of the API if you go to the URL in your browser. Swagger documentation is used in this demo to showcase the different API end points and how they can be invoked. More details on the Swagger documentation can be found in the [appendix](#swagger-documentation).
0 commit comments