{"id":28025938,"url":"https://github.com/codercatdev/couchbase-node-starter","last_synced_at":"2025-05-11T04:53:56.566Z","repository":{"id":257849293,"uuid":"869225557","full_name":"codercatdev/couchbase-node-starter","owner":"codercatdev","description":"Couchbase Node.js Starter Kit","archived":false,"fork":false,"pushed_at":"2024-10-16T12:59:07.000Z","size":72,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-11T04:53:53.429Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codercatdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-07T23:55:00.000Z","updated_at":"2024-10-16T12:59:12.000Z","dependencies_parsed_at":"2024-10-16T18:12:00.558Z","dependency_job_id":"ac244036-1bb9-47f7-88fd-883f6e00b088","html_url":"https://github.com/codercatdev/couchbase-node-starter","commit_stats":null,"previous_names":["codercatdev/couchbase-node-starter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codercatdev%2Fcouchbase-node-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codercatdev%2Fcouchbase-node-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codercatdev%2Fcouchbase-node-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codercatdev%2Fcouchbase-node-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codercatdev","download_url":"https://codeload.github.com/codercatdev/couchbase-node-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253518958,"owners_count":21921082,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-11T04:53:55.976Z","updated_at":"2025-05-11T04:53:56.555Z","avatar_url":"https://github.com/codercatdev.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!---\nThis is a sample README.md file for a Couchbase Starter Kit. It includes a template for the README file that you can use in your repository. You can copy the contents of this file and replace the placeholders with the appropriate information for your starter kit.\n--\u003e\n\n# Couchbase [Node/JavaScript] Starter Kit\n\n![Test Suite](https://github.com/codercatdev/couchbase-node-starter/actions/workflows/test-connection.yml/badge.svg)\n![Couchbase Capella](https://img.shields.io/badge/Couchbase_Capella-Enabled-red)\n[![License: MIT](https://cdn.prod.website-files.com/5e0f1144930a8bc8aace526c/65dd9eb5aaca434fac4f1c34_License-MIT-blue.svg)](/LICENSE)\n![Static Badge](https://img.shields.io/badge/Code_of_Conduct-Contributor_Covenant-violet.svg)\n\n[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/couchbase-starter-kit/URL)\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/couchbase-starter-kit/URL)\n\n## Configuration\n\n| Variable Name                      | Description                                                 |      Default value       |\n|:-----------------------------------|:------------------------------------------------------------|:------------------------:|\n| NODE_COUCHBASE_CONNECTION_STRING  | A couchbase connection string                           |            -             |\n| NODE_COUCHBASE_USERNAME           | Username for authentication with Couchbase              |            -             |\n| NODE_COUCHBASE_PASSWORD           | Password for authentication with Couchbase              |            -             |\n| COUCHBASE_USE_CAPELLA              | Use to change the connection profile                        |          false           |\n| COUCHBASE_DEFAULT_BUCKET           | The name of the Couchbase Bucket, parent of the scope       |         default          |\n| COUCHBASE_DEFAULT_SCOPE            | The name of the Couchbase scope, parent of the collection   |         _default         |\n| COUCHBASE_DEFAULT_COLLECTION       | The name of the Couchbase collection to store the Documents |         _default         |\n| COUCHBASE_OTLP_ENABLED             | Enable traces and metrics OTLP export                       |          false           |\n| COUCHBASE_OTLP_ENDPOINT            | The OTLP server endpoint to send metrics and traces         |            -             |\n\n### Getting started\n\nFollow these steps to get the starter kit up and running on your local machine.\n\n**Prerequisites**\n\nMake sure you have the following installed:\n\n* Node.js\n\nYou will also need an account on Couchbase Capella to create a cluster and obtain the connection details.\n\n**Clone the repository**\n\n```bash\ngit clone https://github.com/codercatdev/couchbase-node-starter.git\ncd URL\n```\n\n**Install dependencies**\n\n```bash\nnpm install\n```\n\n**Configure Couchbase Credentials**\n\nCopy 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:\n\n```bash\nNODE_COUCHBASE_CONNECTION_STRING=\nNODE_COUCHBASE_USERNAME=\nNODE_COUCHBASE_PASSWORD=\nCOUCHBASE_USE_CAPELLA=\nCOUCHBASE_DEFAULT_BUCKET=default\nCOUCHBASE_DEFAULT_SCOPE=_default\nCOUCHBASE_DEFAULT_COLLECTION=_default\nCOUCHBASE_OTLP_ENABLED=false\nCOUCHBASE_OTLP_ENDPOINT=\n```\n\nYou 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 `node_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 (for now this is hardcoded).\n\nOnce 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 `NODE_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 `NODE_COUCHBASE_USERNAME` and `NODE_COUCHBASE_PASSWORD` environment variables.\n\n**Running the Test Suite**\n\nThis application includes the beginnings of a test suite using Jest. To run the test suite, use the following command:\n\n```bash\nnpx jest\n```\n\nThis 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 `npx test` command, as follows:\n\n```bash\nnpx test -- something.test.js\n```\n\n**Starting the Application**\n\nTo start the application, run the following command:\n\n```bash\nnpm run start\n```\n\nThis will start the [Node.js] server, and the command will run automatically showing the results in the command line.\n\n### Contributing\n\nContributions 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).\n\n### License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodercatdev%2Fcouchbase-node-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodercatdev%2Fcouchbase-node-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodercatdev%2Fcouchbase-node-starter/lists"}