{"id":15143769,"url":"https://github.com/contentful/the-example-app.kotlin","last_synced_at":"2025-09-29T12:31:06.042Z","repository":{"id":50518260,"uuid":"132734874","full_name":"contentful/the-example-app.kotlin","owner":"contentful","description":"The example Android app. See how to connect to a sample space and use kotlin and Contentful unisono.","archived":true,"fork":false,"pushed_at":"2023-01-18T10:12:56.000Z","size":51112,"stargazers_count":16,"open_issues_count":1,"forks_count":25,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-09-27T10:03:57.595Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/contentful.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-09T09:37:45.000Z","updated_at":"2024-07-26T08:59:15.000Z","dependencies_parsed_at":"2023-02-10T14:31:25.848Z","dependency_job_id":null,"html_url":"https://github.com/contentful/the-example-app.kotlin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fthe-example-app.kotlin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fthe-example-app.kotlin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fthe-example-app.kotlin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fthe-example-app.kotlin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/contentful","download_url":"https://codeload.github.com/contentful/the-example-app.kotlin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234619452,"owners_count":18861456,"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":"2024-09-26T10:03:48.798Z","updated_at":"2025-09-29T12:31:03.040Z","avatar_url":"https://github.com/contentful.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e **Note**: This repo is no longer officially maintained as of Jan, 2023.\n\u003e Feel free to use it, fork it and patch it for your own needs.\n\n![header](assets/store_feature_graphic.png)\n\n[![Build Status](https://app.bitrise.io/app/e28f5db64f9dcc90/status.svg?token=7Qkboqi4aHGpzkxU86rN0w)](https://app.bitrise.io/app/e28f5db64f9dcc90)\n\n## The Kotlin example app\n\nThis Kotlin example app teaches the very basics of how to work with Contentful for Android:\n\n- consume content from the Contentful Delivery and Preview APIs\n- model content\n- edit content through the Contentful web app\n\nThe app demonstrates how decoupling content from its presentation enables greater flexibility and facilitates shipping higher quality software more quickly.\n\n\u003cimg src=\"assets/styled_course_cards.png\" width=\"200\"/\u003e\u003cimg src=\"assets/styled_lesson.png\" width=\"200\"/\u003e\u003cimg src=\"assets/md_lesson_with_images.png\" width=\"200\"/\u003e\u003cimg src=\"assets/qr_scanning_in_progress.png\" width=\"200\"/\u003e\n\nInstalling the app can be done through this link: \u003ca href=\"https://play.google.com/store/apps/details?id=com.contentful.tea.kotlin\" target=\"_blank\"\u003eThe Kotlin example app on the play store\u003c/a\u003e.\n\n## What is Contentful?\n\n[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.\n\n## Requirements\n\n* Android Studio\n* Git\n* Contentful CLI (only for write access)\n* Android build tools v 28+\n* An Android phone 7.0 and up\n\nWithout any changes, this app is connected to a Contentful space with read-only access. To experience the full end-to-end Contentful experience, you need to connect the app to a Contentful space with read _and_ write access. This enables you to see how content editing in the Contentful web app works and how content changes propagate to this app.\n\n## Common setup\n\nClone the repo and install the dependencies.\n\n```bash\ngit clone https://github.com/contentful/the-example-app.kotlin.git\n```\n\nOpen Android Studio and create a new project from the just downloaded source.\n\n\n## Steps for read-only access\n\nOpen `gradle.build` in Android Studio and run the app on an emulator or directly on a device.\n\n## Steps for read and write access (recommended)\n\nStep 1: Install the [Contentful CLI](https://www.npmjs.com/package/contentful-cli)\n\nStep 2: Login to Contentful through the CLI. It will help you to create a [free account](https://www.contentful.com/sign-up/) if you don't have one already.\n\n```\ncontentful login\n```\n\nStep 3: Create a new space\n\n```\ncontentful space create --name 'My space for the example app'\n```\n\nStep 4: Seed the new space with the content model. Replace the `SPACE_ID` with the id returned from the create command executed in step 3\n\n```\ncontentful space seed -s '\u003cSPACE_ID\u003e' -t the-example-app\n```\n\nStep 5: Head to the Contentful web app's API section and grab `SPACE_ID`, `DELIVERY_ACCESS_TOKEN`, `PREVIEW_ACCESS_TOKEN`.\n\nStep 6: Open \u003ca href=\"app/build.gradle\"\u003eapp/build.gradle\u003c/a\u003e and inject your credentials so it looks like this\n\n```\nbuildConfigField(\"String\", \"CONTENTFUL_DELIVERY_TOKEN\", \"\\\"DELIVERY_TOKEN\\\"\")\nbuildConfigField(\"String\", \"CONTENTFUL_PREVIEW_TOKEN\", \"\\\"PREVIEW_TOKEN\\\"\")\nbuildConfigField(\"String\", \"CONTENTFUL_SPACE_ID\", \"\\\"SPACE_ID\\\"\")\n```\n\nStep 7: Open `the-example-app.kotlin` in Android Studio and run the app on an emulator or device and take a look around the app.\n\n\u003cb\u003eEnjoy exploring the app and feel free to leave \u003ca href=\"https://github.com/contentful/the-example-app.kotlin/issues/new\"\u003efeedback\u003c/a\u003e.\u003c/b\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontentful%2Fthe-example-app.kotlin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontentful%2Fthe-example-app.kotlin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontentful%2Fthe-example-app.kotlin/lists"}