{"id":19967596,"url":"https://github.com/ceramicstudio/orbisdb-express-server","last_synced_at":"2025-09-15T07:12:49.688Z","repository":{"id":251243709,"uuid":"836423962","full_name":"ceramicstudio/orbisdb-express-server","owner":"ceramicstudio","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-19T18:36:24.000Z","size":607,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-01T17:47:47.474Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ceramicstudio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"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-07-31T20:21:33.000Z","updated_at":"2024-08-01T16:54:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"3b4c533d-aa5f-41be-bd22-f19cb7ccb4fb","html_url":"https://github.com/ceramicstudio/orbisdb-express-server","commit_stats":null,"previous_names":["ceramicstudio/orbisdb-express-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ceramicstudio/orbisdb-express-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicstudio%2Forbisdb-express-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicstudio%2Forbisdb-express-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicstudio%2Forbisdb-express-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicstudio%2Forbisdb-express-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ceramicstudio","download_url":"https://codeload.github.com/ceramicstudio/orbisdb-express-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicstudio%2Forbisdb-express-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275220856,"owners_count":25426162,"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","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-11-13T02:42:49.337Z","updated_at":"2025-09-15T07:12:49.678Z","avatar_url":"https://github.com/ceramicstudio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OrbisDB Express Server Demo\n\nThis directory contains an example server (using Express) that displays how OrbisDB can be packaged in a simple server and made available to different environments to process http requests.\n\n## OrbisDB Studio\n\nYou can use the [OrbisDB Hosted Studio](https://studio.useorbis.com/) to get up and running easily with this demo. You always have the option to move over to a standalone instance after. \n\n## Getting started\n\nTo get up and running and start experimenting with this server:\n\n1. Install the dependencies from the root of this directory:\n\n```bash\nnpm install\n```\n\n2. Create a copy of the example environment file:\n\n```bash\ncp .env.example .env\n```\n\nWe will fill in the corresponding values in the following steps\n\n3. Create a private Ceramic seed you will use to perform write operations on Ceramic. This seed will be used by the OrbisDB SDK to instantiate a DID (Decentralized Identifier) that will appear as the sole controller of the content you write.\n\nInvoke the following command to create one:\n\n```bash\nnpm run generate\n```\n\nCopy the corresponding value from your server console log into your new `.env` file next to `CERAMIC_PRIVATE_KEY`.\n\n4. After logging into the [Hosted OrbisDB Studio](https://studio.useorbis.com/) you will see relevant information on the right-hand side in a box called \"Setup.\"\n\nIn your `.env` file, make the following assignments:\n\nENV_ID: (Value under \"Environment ID\" in the studio)\nINSTANCE_URL: (Value under \"OrbisDB Instance URL\")\nCERAMIC_URL: (Value under \"Ceramic Node URL\")\n\n5. In the same page, set up a new context by clicking the blue `+ Add context` button. Copy the corresponding ID into your `.env` file and assign it to `CONTEXT_ID`.\n\n6. Finally, go to the \"Model builder\" tab of your studio view and create a new model using the definition below:\n\n```SQL\n-- LIST accountRelation\n\ntable validation_assignments {\n  stream_id text -- The stream id of the post - auto-generated (do not define when creating table)\n  controller text -- The DID controller of the post - auto-generated (do not define when creating table)\n  data text\n  score number\n  status number\n  stake_id number\n  created_at DateTime\n  updated_at DateTime\n  assigned_at DateTime\n  validated_at DateTime\n  validation_phase text\n  task_submission_id number\n}\n```\n\n7. You are now ready to run the server! Run the following command in your terminal:\n\n```bash\nnpm run dev\n```\n\nYour server is now accessible and running on local port 8080.\n\n## License\n\nDual licensed under MIT and Apache 2\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceramicstudio%2Forbisdb-express-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fceramicstudio%2Forbisdb-express-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceramicstudio%2Forbisdb-express-server/lists"}