Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/couchbase-starter-kit/couchbase-rails-starter

A starter kit for building Rails applications with Couchbase integration. Includes sample configurations, environment setup, and a test suite using RSpec.
https://github.com/couchbase-starter-kit/couchbase-rails-starter

codespaces conduit couchbase devcontainer gitpod rails starter starter-kit workshop

Last synced: 3 months ago
JSON representation

A starter kit for building Rails applications with Couchbase integration. Includes sample configurations, environment setup, and a test suite using RSpec.

Host: GitHub
URL: https://github.com/couchbase-starter-kit/couchbase-rails-starter
Owner: couchbase-starter-kit
License: mit
Created: 2024-07-02T08:47:15.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-09-09T10:54:35.000Z (4 months ago)
Last Synced: 2024-10-06T10:32:36.520Z (3 months ago)
Topics: codespaces, conduit, couchbase, devcontainer, gitpod, rails, starter, starter-kit, workshop
Language: Ruby
Homepage:
Size: 15 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Couchbase Rails Starter Kit

![Test Suite](https://github.com/couchbase-starter-kit/couchbase-rails-starter/actions/workflows/run-tests.yml/badge.svg)
![Couchbase Capella](https://img.shields.io/badge/Couchbase_Capella-Enabled-red)
[![License: MIT](https://cdn.prod.website-files.com/5e0f1144930a8bc8aace526c/65dd9eb5aaca434fac4f1c34_License-MIT-blue.svg)](/LICENSE)
![Static Badge](https://img.shields.io/badge/Code_of_Conduct-Contributor_Covenant-violet.svg)

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/couchbase-starter-kit/couchbase-rails-starter)
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/couchbase-starter-kit/couchbase-rails-starter)

## Configuration

| Variable Name | Description | Default value |
|:-----------------------------------|:------------------------------------------------------------|:------------------------:|
| RAILS_COUCHBASE_CONNECTION_STRING | A couchbase connection string | - |
| RAILS_COUCHBASE_USERNAME | Username for authentication with Couchbase | - |
| RAILS_COUCHBASE_PASSWORD | Password for authentication with Couchbase | - |
| COUCHBASE_USE_CAPELLA | Use to change the connection profile | false |
| COUCHBASE_DEFAULT_BUCKET | The name of the Couchbase Bucket, parent of the scope | default |
| COUCHBASE_DEFAULT_SCOPE | The name of the Couchbase scope, parent of the collection | _default |
| COUCHBASE_DEFAULT_COLLECTION | The name of the Couchbase collection to store the Documents | _default |

### Getting started

Follow these steps to get the starter kit up and running on your local machine.

**Prerequisites**

Make sure you have the following installed:

* Ruby 3.3.x
* Bundler
* Rails 7.0.x
* Git

You will also need an account on Couchbase Capella to create a cluster and obtain the connection details.

**Clone the repository**

```bash
git clone https://github.com/couchbase-conduit-workshop/couchbase-rails-starter.git
cd couchbase-rails-starter
```

**Install dependencies**

```bash
bundle install
```

**Configure Couchbase Credentials**

Copy the `.env.sample` file in the root directory of the project and rename it to `.env`. Update the `.env` file with your Couchbase credentials as follows:

```bash
RAILS_COUCHBASE_USERNAME=your_RAILS_COUCHBASE_USERNAME
RAILS_COUCHBASE_PASSWORD=your_RAILS_COUCHBASE_PASSWORD
RAILS_COUCHBASE_CONNECTION_STRING=your_RAILS_COUCHBASE_CONNECTION_STRING_url
COUCHBASE_DEFAULT_BUCKET=your_COUCHBASE_DEFAULT_BUCKET
```

You can obtain those credentials by first creating an account on Couchbase Capella at [https://cloud.couchbase.com/](https://cloud.couchbase.com/) and then creating a database called `rails_starter_app`. Inside the database, create a bucket. The name of the bucket is what you should use for the `COUCHBASE_DEFAULT_BUCKET` environment variable.

Once you have done so, you can navigate to the `Connect` tab in the database and copy the connection string URL. This is what you should use for the `RAILS_COUCHBASE_CONNECTION_STRING` environment variable. You will also need to create a user with the appropriate permissions and use the username and password for the `RAILS_COUCHBASE_USERNAME` and `RAILS_COUCHBASE_PASSWORD` environment variables.

**Running the Test Suite**

This application includes the beginnings of a test suite using RSpec. To run the test suite, use the following command:

```bash
bundle exec rspec
```

This will run all the tests and output the results in the terminal. You can run any specific test file by passing the file path as an argument to the `rspec` command, as follows:

```bash
bundle exec rspec spec/config/couchbase_spec.rb
```

**Starting the Application**

To start the application, run the following command:

```bash
bundle exec rails server
```

This will start the Rails server, and you can access the application at [http://localhost:3000](http://localhost:3000).

### Contributing

Contributions are more than welcome! If you encounter any bugs or issues with the application, please open an issue on the GitHub repository. If you would like to contribute code, feel free to open a pull request with your changes. All contributors are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md).

### License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.