diff --git a/modules/getting-started/pages/starter-kits.adoc b/modules/getting-started/pages/starter-kits.adoc index 7b05738365..39abf2b288 100644 --- a/modules/getting-started/pages/starter-kits.adoc +++ b/modules/getting-started/pages/starter-kits.adoc @@ -1,7 +1,8 @@ // Starter Kits for Couchbase Developers = Starter Kits +:page-layout: landing-page-top-level-sdk :page-role: tiles -:url-guides-org: https://github.com/couchbase-guides +// :page-rank: 70 :!sectids: :description: Starter kits are repositories containing example code to get you started with various development projects. @@ -21,70 +22,349 @@ ifdef::basebackend-html[] ++++ endif::[] -{description} += Starter Kits + +Couchbase's https://www.couchbase.com/developers/[Developer Site] contains several useful https://developer.couchbase.com/tutorials/[Tutorials]. +These tutorials cover developing for Couchbase, using Couchbase SDKs, within the context of a wider software ecosystem -- such as developing with the Java SDK, using Spring Data. + +Go to the https://developer.couchbase.com/tutorials/#cb-tutorials-container-header[Developer Tutorials] or the +https://github.com/couchbase-examples[GitHub repo] for a full listing. +Here we list some of the more popular tutorials. + -== Couchbase Server in Docker -Start a Couchbase Server Docker Container and connect to the server using the Couchbase CLI. -{url-guides-org}/couchbase-docker[Learn more] +[.column] +====== {empty} -== Couchbase Server on Amazon EC2 -Start an EC2 instance and connect to the server using the Couchbase CLI. -{url-guides-org}/couchbase-amazon-cli[Learn more] +== Agentic Apps, LLM, & RAG + +++++ +
+++++ + -== Couchbase Server with ASP.NET Core +[.column] +====== {empty} +.Agent Catalog Quickstart -Create a "`hello world`" ASP.NET Core web application that uses Couchbase Server as the backend database. +[.content] +This repository provides a quickstart guide for using the Agent Catalog with Capella Model Services and Couchbase. +[] +https://github.com/couchbase-examples/agent-catalog-quickstart[Agent Catalog Quickstart] -{url-guides-org}/asp-net-core-mvc[Learn more] -== Couchbase with Java SDK -Create a Java application that uses Couchbase Server as the backend to store a JSON document. +[.column] +====== {empty} +.Chatbot Demo + +[.content] +Q&A Chatbot Demo using Couchbase, `LangChain`, `OpenAI`, and `Streamlit`. +[] +https://github.com/couchbase-examples/qa-bot-demo[Chatbot Demo] + + ++++ +
++++ + +== {empty} + +++++ +
+++++ -{url-guides-org}/java-sdk[Learn more] -== Couchbase with Node.js using Express Framework +[.column] +====== {empty} +.Llamaindex RAG Demo -Create a "`hello world`" Node.js web application that uses Couchbase Server as the backend database. +[.content] +A RAG demo using `LlamaIndex` that allows you to chat with your uploaded PDF documents. +[] +https://github.com/couchbase-examples/rag-demo-llama-index[Llamaindex RAG Demo] -{url-guides-org}/nodejs-express[Learn more] -== Couchbase with NativeScript using Angular -Create a "`hello world`" NativeScript mobile application that uses Couchbase Server, NativeScript, and Angular. +[.column] +====== {empty} +.Spring AI & Couchbase Victor Store + +[.content] +A simple Spring Boot application to demonstrate the usage of Couchbase Vector Store with Spring AI. +[] +https://github.com/couchbase-examples/couchbase-spring-ai-demo[Spring AI & Couchbase Victor Store] + + ++++ +
++++ + + + +[.column] +====== {empty} + + +== Server SDKs + + +++++ +
+++++ + +[.column] +====== {empty} +.ASP.NET & EFCore + +[.content] +A sample ASP.NET app using Couchbase and EF Core to demonstrate CRUD operations and basic queries with sample data models. +[] +https://github.com/couchbase-examples/aspnet-efcore-quickstart[ASP.NET & EFCore] -{url-guides-org}/nativescript-angular[Learn more] -== Couchbase with Python SDK -Create a simple Python application to store and retrieve a JSON document in Couchbase Server. +[.column] +====== {empty} +.{cpp} Quickstart + +[.content] +Entry level Couchbase demo/tutorial with {cpp}. +[] +https://github.com/couchbase-examples/cxx-quickstart[{cpp} Quickstart] + + + +[.column] +====== {empty} +.Golang & Gin Gonic + +[.content] +Entry level Couchbase Golang Gin Gonic tutorial/demo. +This repo is designed to teach you how to connect to a Couchbase Capella cluster to create, read, update, and delete documents using Key Value operations +and how to write simple parametrized SQL++ queries using the built-in travel-sample bucket. +[] +https://github.com/couchbase-examples/golang-quickstart[Golang & Gin Gonic] + + ++++ +
++++ + +== {empty} + +++++ +
+++++ + + +[.column] +====== {empty} +.Java Transactions + +[.content] +A Spring Boot application that illustrates using Couchbase transactions with the Java SDK. +[] +https://github.com/couchbase-examples/java-transactions-quickstart[Java Transactions] + + +[.column] +====== {empty} +.Node.js & Ottoman + +[.content] +Entry level Couchbase Ottoman and NodeJS tutorial/demo. +Steps to build a REST API to manage user profile CRUD operations in Couchbase Server. +[] +https://github.com/couchbase-examples/ottomanjs-quickstart[Node.js & Ottoman] + + +// https://github.com/couchbase-examples/couchbase-flask-realworld-example-app[] + + +[.column] +====== {empty} +.PHP & Laravel + +[.content] +Quickstart in Couchbase with PHP using Laravel. +This repo is designed to teach you how to connect to a Couchbase Capella cluster to create, read, update, and delete documents using Key Value operations +and how to write simple parametrized SQL++ queries using the built-in travel-sample bucket. +[] +https://github.com/couchbase-examples/php-laravel-quickstart[PHP & Laravel] + + ++++ +
++++ + +== {empty} + +++++ +
+++++ -{url-guides-org}/python-sdk[Learn more] -== Couchbase Lite (CBL) on Android -Build an Android application consisting of a single activity that performs CRUD operations and uses Couchbase Lite to store documents locally on the device. +[.column] +====== {empty} +.Python & Jupyter Labs + +[.content] +A series of labs created to start using Couchbase with the Python SDK. +[] +https://github.com/couchbase-examples/couchbase-jupyter-labs[Python & Jupyter Labs] + + +[.column] +====== {empty} +.Build a REST API with Ruby Couchbase ORM + +[.content] +A starter project in Ruby on Rails to generate a REST API performing Create, Read, Update, and Delete (CRUD) operations for the Couchbase database. +[] +https://github.com/couchbase-examples/ruby-couchbase-orm-quickstart[Ruby Couchbase ORM] + + +[.column] +====== {empty} +.Scala Quickstart + +[.content] +Entry level Couchbase Scala tutorial/demo. +Steps to build REST APIs to manage user profile CRUD operations. +[] +https://github.com/couchbase-examples/scala-quickstart[Scala Quickstart] + ++++ +
++++ + +[.column] +====== {empty} + + + +== Mobile & Edge + +++++ +
+++++ + + +[.column] +====== {empty} +.Android & Java + +[.content] +Quickstart in Couchbase Lite using a standalone database with Android and Java. +This tutorial will show you how to use Query Builder to do queries in the database and how to use a pre-built database in your applications. +[] +https://github.com/couchbase-examples/android-java-cblite-userprofile-query[Android & Java] + + + +[.column] +====== {empty} +.Android & Kotlin + +[.content] +Learn Couchbase Lite SDK with Kotlin and `JetPack Compose` for Android Developers. +[] +https://github.com/couchbase-examples/android-kotlin-cbl-learning-path[Android & Kotlin] + + + +[.column] +====== {empty} +.Dart & Flutter + +[.content] +An Android and iOS Application that uses the community-supported Couchbase Lite SDK for Dart and Flutter. +You will learn how to get and insert documents using the key-value engine, and query the database using the `QueryBuilder` engine or {sqlpp}. +Learn how to sync information between your mobile app and a Couchbase Server using Sync Gateway -- or using peer-to-peer technology. +[] +https://github.com/couchbase-examples/flutter_cbl_learning_path[Dart and Flutter] + + ++++ +
++++ + +== {empty} + +++++ +
+++++ + + +[.column] +====== {empty} +.Edge Server & TypeScript + +[.content] +The sample React-based web application simulates an airline seat back application, that allows users in business and economy class to place their in-flight meal orders. +The sample app leverages Couchbase Edge Server for data storage and processing at the edge, simulating a disconnected offline experience within an aircraft. +The seatback web app accesses Edge Server via a RESTful interface. +When there is Internet connectivity, the Edge Server syncs data with remote Capella App Services. + +https://github.com/couchbase-examples/edge-server-meal-order-sample-app[Edge Server & TypeScript] + + +[.column] +====== {empty} +.iOS Swift P2P Quickstart + +[.content] +This quick-start app demonstrates how to use Couchbase Lite Swift to load a prebuilt database, create and update documents, and query documents. +It also shows how to set up peer-to-peer replication using the Multipeer Replicator, which leverages DNS-SD (Bonjour) for automatic peer discovery over Wi-Fi, enabling synchronization between nearby devices without requiring a centralized server. +[] +https://github.com/couchbase-examples/ios-swift-quickstart-p2p[iOS Swift P2P Quickstart] + + +[.column] +====== {empty} +.React Native + +[.content] +Expo-based React Native app that uses `cbl-reactnative` and the Travel Sample bucket dataset with the hotels and landmark collections. + +https://github.com/couchbase-examples/expo-cbl-travel[React Native Expo Travel Sample App] + + ++++ +
++++ + + + + +//// + +== Other + + + +++++ +
+++++ + -{url-guides-org}/java-android[Learn more] +Demo to search hotels by city using an AWS AppSync GraphQL API backed by Couchbase Data API, with a Streamlit frontend for visualization. -== Couchbase Backup +https://github.com/couchbase-examples/couchbase-data-api-serverless-cookbook[] -Learn how to create backups from Couchbase Server. -{url-guides-org}/couchbase-backup[Learn more] -== Couchbase Restore -Learn how to restore backups to Couchbase Server. ++++ +
++++ -{url-guides-org}/couchbase-restore[Learn more] -== Write Your Own Starter Kit +//// -Use these guidelines to build your own guide using AsciiDoc and push it to the couchbase-guides Github repository. -{url-guides-org}/how-to-write-a-guide[Learn more]