Skip to content

Commit 4a5d564

Browse files
committed
Update .gitignore and README.md files and added images
1 parent 61034d9 commit 4a5d564

File tree

6 files changed

+8
-4
lines changed

6 files changed

+8
-4
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
# or operating system, you probably want to add a global ignore instead:
55
# git config --global core.excludesfile '~/.gitignore_global'
66

7+
.vscode/
8+
.idea/
9+
tmp/
10+
711
# Environment Variables
812
dev.env
913

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,11 @@ docker run -p 3000:3000 couchbase-rails-quickstart -e DB_CONN_STR=<connection_st
9494

9595
Once the application starts, you can see the details of the application on the terminal.
9696

97-
Show Image
97+
![Application Start](./assets/images/app_startup.png)
9898

9999
The application will run on the port specified by Rails on your local machine (eg: 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 endpoints and how they can be invoked. More details on the Swagger documentation can be found in the appendix.
100100

101-
Show Image
101+
![Swagger Documentation](./assets/images/swagger_documentation.png)
102102

103103
## Running The Tests
104104

@@ -122,7 +122,7 @@ bundle exec rspec test/integration
122122

123123
For this quickstart, we use three collections, airport, airline and routes that contain sample airports, airlines and airline routes respectively. The routes collection connects the airports and airlines as seen in the figure below. We use these connections in the quickstart to generate airports that are directly connected and airlines connecting to a destination airport. Note that these are just examples to highlight how you can use SQL++ queries to join the collections.
124124

125-
![Data Model](image_link)
125+
![Data Model](./assets/images/travel_sample_data_model.png)
126126

127127
## Extending API by Adding New Entity
128128

assets/images/app_startup.png

202 KB
Loading
554 KB
Loading
66.7 KB
Loading

dev.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
DB_USERNAME="kaustav"
1+
DB_USERNAME="Administrator"
22
DB_PASSWORD="password"
33
DB_CONN_STR="couchbase://localhost"

0 commit comments

Comments
 (0)