Contribute a Kotlin Couchbase Starter Kit

[hummusonrails]

Looking to participate in Hacktoberfest 2024? 👻

Here's a fantastic way to contribute to Couchbase's open-source ecosystem by creating a Kotlin Starter Kit!

Couchbase already has starter kits for frameworks like Spring and Rails, but we're missing one for Kotlin! This is where YOU can make a difference. Help us build a Kotlin Couchbase starter kit to assist other developers, like yourself, in easily integrating Couchbase into their Kotlin applications.

What You’ll Do:

TL;DR: Create a Kotlin app showcasing Couchbase's core features, ensuring cross-platform compatibility, with a detailed README and tests. The final outcome is a new GitHub repo in your account for the starter kit, plus a PR in this repo adding your project to the community contributions section.

• Set up a basic Kotlin app with the framework of your choice that connects to a Couchbase cluster.
• Use the Couchbase Kotlin SDK to demonstrate key functionalities.
• Include a sample .env file with necessary environment variables for connecting to Couchbase.
• Create a README.md with setup instructions.
• Configure deployment support for Gitpod and GitHub Codespaces.
• Add a test that verifies the connection to Couchbase using GitHub Actions.

Basic Requirements:

Your Kotlin starter kit should include:

• [ ] Connection to Couchbase: With both Couchbase Server and Capella support.
• [ ] Environment Variables: Use the existing template provided in the samples directory of this repository.
• [ ] Deployment Configurations: Provide setup for Gitpod and GitHub Codespaces.
• [ ] Testing: Add a simple test workflow to validate the connection to Couchbase.

Resources:

READ THIS FIRST - Instructions for getting started

• Couchbase Kotlin SDK Documentation
• Sample README for your project
• Hacktoberfest Details

How To Get Started:

Follow the contribution instructions, and submit a pull request using the new starter kit pull request template with a link to your Kotlin starter kit.

Good luck on your adventure! ✨

[realjoni17]

Hi i want to contribute to this

[hummusonrails]

Hi i want to contribute to this

Excellent, welcome @realjoni17! Let us know if you have any questions or need help along the way. Excited to see what you build!

cc: @ldoguin @shivaylamba