Skip to content

Commit 788f426

Browse files
committed
updated readme
1 parent ed87865 commit 788f426

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Often, the first step developers take after creating their database is to create
77
- 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.
88
- How to write simple parameterized SQL++ queries using the built-in travel-sample bucket.
99

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)
1111

1212
## Prerequisites
1313

@@ -29,17 +29,21 @@ If travel-sample is not loaded in your Capella cluster, you can load it by follo
2929
We will walk through the different steps required to get the application running.
3030

3131
### Cloning Repo
32+
3233
```sh
3334
git clone https://github.com/couchbase-examples/ruby-on-rails-quickstart.git
3435
```
36+
3537
### Install Dependencies
38+
3639
Any dependencies will be installed by running the bundle install command, which installs any dependencies required for the project.
3740

3841
```sh
3942
bundle install
4043
```
4144

4245
### Setup Database Configuration
46+
4347
To learn more about connecting to your Capella cluster, please follow the instructions.
4448

4549
Specifically, you need to do the following:
@@ -55,30 +59,39 @@ DB_CONN_STR=<connection_string>
5559
DB_USERNAME=<user_with_read_write_permission_to_travel-sample_bucket>
5660
DB_PASSWORD=<password_for_user>
5761
```
62+
5863
Note: The connection string expects the couchbases:// or couchbase:// part.
5964

6065
## Running The Application
6166

6267
### Directly on machine
68+
6369
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.
6470

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.
6672

6773
```sh
6874
rails server
6975
```
76+
7077
### Using Docker
78+
7179
- Build the Docker image
80+
7281
```sh
7382
docker build -t couchbase-rails-quickstart .
7483
```
84+
7585
- Run the Docker image
86+
7687
```sh
7788
docker run -p 3000:3000 couchbase-rails-quickstart -e DB_CONN_STR=<connection_string> -e DB_USERNAME=<user_with_read_write_permission_to_travel-sample_bucket> -e DB_PASSWORD=<password_for_user>
7889
```
90+
7991
> 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.
8092
8193
## Verifying the Application
94+
8295
Once the application starts, you can see the details of the application on the terminal.
8396

8497
Show Image
@@ -88,6 +101,7 @@ The application will run on the port specified by Rails on your local machine (e
88101
Show Image
89102

90103
## Running The Tests
104+
91105
Create a copy of dev.env.example file and rename it to dev.env and add the values for the Couchbase connection.
92106

93107
```sh
@@ -97,9 +111,11 @@ DB_PASSWORD=<password_for_user>
97111
```
98112

99113
### Run the integration tests
114+
100115
```sh
101116
bundle exec rspec test/integration
102117
```
118+
103119
# Appendix
104120

105121
## Data Model
@@ -144,4 +160,3 @@ Execution: Once you've inputted all the necessary parameters, you can click the
144160
### Models
145161

146162
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.
147-

0 commit comments

Comments
 (0)