feat: cheqd Studio rebranding [DEV-4010] (#550)

* feat: cheqd Studio rebranding * Revert npm package name change * Update API links
cheqd · Jul 2, 2024 · bb58b44 · bb58b44
1 parent 9376e81
commit bb58b44
Show file tree

Hide file tree

Showing 13 changed files with 524 additions and 524 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -109,12 +109,12 @@ jobs:
                   load: true
                   target: runner
                   tags: ${{ steps.meta.outputs.tags }}
-                  outputs: type=docker,dest=credential-service-staging.tar
+                  outputs: type=docker,dest=studio-staging.tar
                   cache-from: type=gha
                   cache-to: type=gha,mode=min
 
             - name: Upload build image as artifact
               uses: actions/upload-artifact@v4
               with:
-                  name: credential-service-staging
-                  path: credential-service-staging.tar
+                  name: studio-staging
+                  path: studio-staging.tar
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -60,7 +60,7 @@ jobs:
             IMAGE_NAME: ${{ github.repository }}
         environment:
             name: production
-            url: https://credential-service.cheqd.net
+            url: https://studio-api.cheqd.net
 
         steps:
             - uses: actions/checkout@v4
@@ -103,8 +103,8 @@ jobs:
                       type=raw,value=production-latest
                       type=sha,format=long
                   labels: |
-                      org.opencontainers.image.description="Cheqd Credential Service"
-                      org.opencontainers.image.source="https://github.com/cheqd/credential-service"
+                      org.opencontainers.image.description="Cheqd Studio"
+                      org.opencontainers.image.source="https://github.com/cheqd/studio"
                       org.opencontainers.image.vendor="Cheqd Foundation Limited"
                       org.opencontainers.image.created={{date 'dddd, MMMM Do YYYY, h:mm:ss a'}}
                       org.opencontainers.image.documentation="https://docs.cheqd.io/identity"

diff --git a/.github/workflows/staging.yml b/.github/workflows/staging.yml
@@ -13,7 +13,7 @@ jobs:
             IMAGE_NAME: ${{ github.repository }}
         environment:
             name: staging
-            url: https://credential-service-staging.cheqd.net
+            url: https://studio-api-staging.cheqd.net
 
         steps:
             - name: Install DigitalOcean CLI
@@ -34,10 +34,10 @@ jobs:
             - name: Download docker image
               uses: actions/download-artifact@v4
               with:
-                  name: credential-service-staging
+                  name: studio-staging
 
             - name: Load Docker image
-              run: docker image load --input credential-service-staging.tar
+              run: docker image load --input studio-staging.tar
 
             - name: Push image to GitHub Container Registry
               run: docker image push --all-tags ghcr.io/${{ env.IMAGE_NAME }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,16 +1,16 @@
 # Credential Service
 
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/credential-service?color=green&label=stable%20release&style=flat-square)](https://github.com/cheqd/credential-service/releases/latest)
-![GitHub Release Date](https://img.shields.io/github/release-date/cheqd/credential-service?color=green&style=flat-square)
-[![GitHub license](https://img.shields.io/github/license/cheqd/credential-service?color=blue&style=flat-square)](https://github.com/cheqd/credential-service/blob/main/LICENSE)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/studio?color=green&label=stable%20release&style=flat-square)](https://github.com/cheqd/studio/releases/latest)
+![GitHub Release Date](https://img.shields.io/github/release-date/cheqd/studio?color=green&style=flat-square)
+[![GitHub license](https://img.shields.io/github/license/cheqd/studio?color=blue&style=flat-square)](https://github.com/cheqd/studio/blob/main/LICENSE)
 
-[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cheqd/credential-service?include_prereleases&label=dev%20release&style=flat-square)](https://github.com/cheqd/credential-service/releases/)
-![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/cheqd/credential-service/latest?style=flat-square)
-[![GitHub contributors](https://img.shields.io/github/contributors/cheqd/credential-service?label=contributors%20%E2%9D%A4%EF%B8%8F&style=flat-square)](https://github.com/cheqd/credential-service/graphs/contributors)
+[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cheqd/studio?include_prereleases&label=dev%20release&style=flat-square)](https://github.com/cheqd/studio/releases/)
+![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/cheqd/studio/latest?style=flat-square)
+[![GitHub contributors](https://img.shields.io/github/contributors/cheqd/studio?label=contributors%20%E2%9D%A4%EF%B8%8F&style=flat-square)](https://github.com/cheqd/studio/graphs/contributors)
 
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/credential-service/dispatch.yml?label=workflows&style=flat-square)](https://github.com/cheqd/credential-service/actions/workflows/dispatch.yml)
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/credential-service/codeql.yml?label=CodeQL&style=flat-square)](https://github.com/cheqd/credential-service/actions/workflows/codeql.yml)
-![GitHub repo size](https://img.shields.io/github/repo-size/cheqd/credential-service?style=flat-square)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/studio/dispatch.yml?label=workflows&style=flat-square)](https://github.com/cheqd/studio/actions/workflows/dispatch.yml)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/studio/codeql.yml?label=CodeQL&style=flat-square)](https://github.com/cheqd/studio/actions/workflows/codeql.yml)
+![GitHub repo size](https://img.shields.io/github/repo-size/cheqd/studio?style=flat-square)
 
 ## ℹ️ Overview
 
@@ -26,8 +26,8 @@ definition endpoints that list all of the APIs and how they work.
 
 The Swagger API definition pages are:
 
-- [Production / Stable Release APIs](https://credential-service.cheqd.net/swagger/)
-- [Staging / Development Release APIs](https://credential-service-staging.cheqd.net/swagger/)
+- [Production / Stable Release APIs](https://studio-api.cheqd.net/swagger/)
+- [Staging / Development Release APIs](https://studio-api-staging.cheqd.net/swagger/)
 
 ## 🔧 Configuration
 
@@ -153,7 +153,7 @@ necessary to configure the service. (See section _Configuration_ above.)
 Construct the postgres URL and configure the env variables mentioned above.
 
 Spinning up a Docker container from the
-[pre-built credential-service Docker image on Github](https://github.com/cheqd/credential-service/pkgs/container/credential-service)
+[pre-built studio Docker image on Github](https://github.com/cheqd/studio/pkgs/container/studio)
 is as simple as the command below:
 
 #### Configure PostgreSQL database
@@ -187,7 +187,7 @@ docker compose -f docker/with-external-db/docker-compose-with-db.yml --profile l
 Configuring LogTo is outside the scope of this guide, and we recommend reading
 [LogTo documentation](https://docs.logto.io/) to familiarise yourself.
 
-#### Start credential-service app
+#### Start studio app
 
 Configure the environment variables in the [`with-db.env` file](docker/with-external-db/with-db.env) with the settings
 described in section above. Depending on whether you are using external Veramo KMS only, LogTo only, or both you will
@@ -224,13 +224,13 @@ docker compose -f docker/with-external-db/docker-compose-with-db.yml --profile l
 To build your own image using Docker, use the [Dockerfile](docker/Dockerfile) provided.
 
 ```bash
-docker build --file docker/Dockerfile --target runner . --tag credential-service:local
+docker build --file docker/Dockerfile --target runner . --tag studio:local
 ```
 
 ## 🐞 Bug reports & 🤔 feature requests
 
 If you notice anything not behaving how you expected, or would like to make a suggestion / request for a new feature,
-please create a [**new issue**](https://github.com/cheqd/credential-service/issues/new/choose) and let us know.
+please create a [**new issue**](https://github.com/cheqd/studio/issues/new/choose) and let us know.
 
 ## 💬 Community
 

diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -1,5 +1,5 @@
 ###############################################################
-###         STAGE 1: Build credential-service app           ###
+###         STAGE 1: Build cheqd studio app                 ###
 ###############################################################
 
 FROM node:18-alpine AS builder
@@ -18,7 +18,7 @@ RUN npm run build
 
 
 ###############################################################
-###         STAGE 2: Build credential-service runner        ###
+###         STAGE 2: Build cheqd studio runner              ###
 ###############################################################
 
 FROM node:18-alpine AS runner

diff --git a/docker/no-external-db/docker-compose-no-db.yml b/docker/no-external-db/docker-compose-no-db.yml
@@ -9,7 +9,7 @@ services:
         # To change the image version, edit the ":latest" tag to the desired version
         # For production/stable release, use ":latest"
         # For development/staging release, use ":staging-latest"
-        image: ghcr.io/cheqd/credential-service:latest
+        image: ghcr.io/cheqd/studio:latest
         ports:
             - 3000:3000
         # NOTE: Edit the values present within this file before running the service

diff --git a/docker/with-external-db/docker-compose-with-db.yml b/docker/with-external-db/docker-compose-with-db.yml
@@ -12,7 +12,7 @@ services:
         # To change the image version, edit the ":latest" tag to the desired version
         # For production/stable release, use ":latest"
         # For development/staging release, use ":staging-latest"
-        image: ghcr.io/cheqd/credential-service:latest
+        image: ghcr.io/cheqd/studio:latest
         depends_on:
             postgres:
                 condition: service_healthy
@@ -33,7 +33,7 @@ services:
     # This service is used as a ONE-TIME setup service to run migrations
     # Only relevant if you're using the app with EXTERNAL_DB=true
     app-migrations:
-        image: ghcr.io/cheqd/credential-service:latest
+        image: ghcr.io/cheqd/studio:latest
         depends_on:
             postgres:
                 condition: service_healthy

diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
 {
 	"name": "@cheqd/credential-service",
 	"version": "2.21.0-develop.2",
-	"description": "cheqd Credential Service Backend",
+	"description": "cheqd Studio Backend",
 	"source": "src/index.ts",
 	"main": "dist/index.js",
 	"license": "Apache-2.0",
 	"author": "Cheqd Foundation Limited (https://github.com/cheqd)",
-	"repository": "https://github.com/cheqd/credential-service.git",
+	"repository": "https://github.com/cheqd/studio.git",
 	"type": "module",
 	"exports": {
 		".": {

diff --git a/src/static/swagger-admin-options.json b/src/static/swagger-admin-options.json
@@ -1,17 +1,17 @@
 {
 	"openapi": "3.0.0",
 	"info": {
-		"title": "Credential Service admin API for cheqd network",
+		"title": "cheqd Studio admin API for cheqd network",
 		"version": "2.0.0",
 		"description": "Admin API which handles users subscriptions and payments",
 		"contact": {
 			"name": "Cheqd Foundation Limited",
-			"url": "https://github.com/cheqd/credential-service",
+			"url": "https://github.com/cheqd/studio",
 			"email": "[email protected]"
 		},
 		"license": {
 			"name": "Apache 2.0",
-			"url": "https://github.com/cheqd/credential-service/blob/main/LICENSE"
+			"url": "https://github.com/cheqd/studio/blob/main/LICENSE"
 		}
 	},
 	"tags": [

diff --git a/src/static/swagger-admin.json b/src/static/swagger-admin.json
@@ -1,17 +1,17 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "title": "Credential Service admin API for cheqd network",
+    "title": "cheqd Studio admin API for cheqd network",
     "version": "2.0.0",
     "description": "Admin API which handles users subscriptions and payments",
     "contact": {
       "name": "Cheqd Foundation Limited",
-      "url": "https://github.com/cheqd/credential-service",
+      "url": "https://github.com/cheqd/studio",
       "email": "[email protected]"
     },
     "license": {
       "name": "Apache 2.0",
-      "url": "https://github.com/cheqd/credential-service/blob/main/LICENSE"
+      "url": "https://github.com/cheqd/studio/blob/main/LICENSE"
     }
   },
   "tags": [

diff --git a/src/static/swagger-api-options.json b/src/static/swagger-api-options.json
@@ -1,17 +1,17 @@
 {
 	"openapi": "3.0.0",
 	"info": {
-		"title": "Credential Service API for cheqd network",
+		"title": "cheqd Studio API for cheqd network",
 		"version": "2.0.0",
 		"description": "API service to create and manage DIDs, Verifiable Credentials, and DID-Linked Resources",
 		"contact": {
 			"name": "Cheqd Foundation Limited",
-			"url": "https://github.com/cheqd/credential-service",
+			"url": "https://github.com/cheqd/studio",
 			"email": "[email protected]"
 		},
 		"license": {
 			"name": "Apache 2.0",
-			"url": "https://github.com/cheqd/credential-service/blob/main/LICENSE"
+			"url": "https://github.com/cheqd/studio/blob/main/LICENSE"
 		}
 	},
 	"tags": [
@@ -38,7 +38,7 @@
 		}
 	],
 	"externalDocs": {
-		"description": "Credential Service API Documentation",
+		"description": "cheqd Studio API Documentation",
 		"url": "https://docs.cheqd.io/identity"
 	}
 }
diff --git a/src/static/swagger-api.json b/src/static/swagger-api.json
@@ -1,17 +1,17 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "title": "Credential Service API for cheqd network",
+    "title": "cheqd Studio API for cheqd network",
     "version": "2.0.0",
     "description": "API service to create and manage DIDs, Verifiable Credentials, and DID-Linked Resources",
     "contact": {
       "name": "Cheqd Foundation Limited",
-      "url": "https://github.com/cheqd/credential-service",
+      "url": "https://github.com/cheqd/studio",
       "email": "[email protected]"
     },
     "license": {
       "name": "Apache 2.0",
-      "url": "https://github.com/cheqd/credential-service/blob/main/LICENSE"
+      "url": "https://github.com/cheqd/studio/blob/main/LICENSE"
     }
   },
   "tags": [
@@ -38,7 +38,7 @@
     }
   ],
   "externalDocs": {
-    "description": "Credential Service API Documentation",
+    "description": "cheqd Studio API Documentation",
     "url": "https://docs.cheqd.io/identity"
   },
   "paths": {