{"id":13425930,"url":"https://github.com/SteinHQ/Stein","last_synced_at":"2025-03-15T20:31:34.626Z","repository":{"id":34923365,"uuid":"190699490","full_name":"SteinHQ/Stein","owner":"SteinHQ","description":"Use Google Sheets as your no-setup database","archived":false,"fork":false,"pushed_at":"2022-12-09T05:26:57.000Z","size":1155,"stargazers_count":817,"open_issues_count":18,"forks_count":64,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-04-27T18:33:26.725Z","etag":null,"topics":["api","google-sheets","json"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SteinHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-07T06:43:12.000Z","updated_at":"2024-04-15T05:59:43.000Z","dependencies_parsed_at":"2023-01-15T10:30:38.944Z","dependency_job_id":null,"html_url":"https://github.com/SteinHQ/Stein","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SteinHQ%2FStein","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SteinHQ%2FStein/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SteinHQ%2FStein/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SteinHQ%2FStein/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SteinHQ","download_url":"https://codeload.github.com/SteinHQ/Stein/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243790939,"owners_count":20348378,"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":["api","google-sheets","json"],"created_at":"2024-07-31T00:01:22.276Z","updated_at":"2025-03-15T20:31:32.822Z","avatar_url":"https://github.com/SteinHQ.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","DevShit","api"],"sub_categories":[],"readme":"\u0026nbsp;\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://steinhq.com\"\u003e\n    \u003cimg src=\"https://steinhq.com/static/media/Logo.7a44b5e9.svg\" alt=\"Stein\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eShip fast and manage your data with ease. Connect to Google Sheets.\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n\tKick off projects, design custom Google Forms, and manage your content in a familiar interface. \n\t\u003cbr\u003e\n\tPower your project with the fully open source Stein.\n\u003c/p\u003e\n\n\u003cp align=\"center\" style=\"font-size:0.75rem\"\u003e\n\t\u003ca href=\"https://steinhq.com\"\u003eSteinHQ.com\u003c/a\u003e | \n\t\u003ca href=\"https://docs.steinhq.com\"\u003eDocumentation\u003c/a\u003e\n\u003c/p\u003e\n\n## Setup\n\nThere are two ways you can get started with the Stein API:\n\n- Use the [hosted service](https://steinhq.com) to get a free \u0026 reliable API in a couple of clicks.\n- Self-host an instance of Stein. Find the related documentation [here](https://docs.steinhq.com/hosting-introduction).\n\n## Examples\n\nDetails and examples on the complete functionality can be found in the [documentation](https://docs.steinhq.com). Here are a few to get you started!\n\nAll the data and the errors are communicated using JSON. You may perform common operations on your sheets such as read, search, write, etc.\n\nStructure your sheet as shown below, with the first row populated with column names.\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://docs.steinhq.com/assets/prepared-sheet.png\" alt=\"Sheet Structure\" /\u003e\n\u003c/p\u003e\n\nA read operation on the sheet will return an array of the rows.\n\n```\n[\n  {\n    \"title\":\"Why the Best Things in Life Can’t Be Planned\",\n    \"content\":\"Thales of Miletus, considered ...\",\n    \"link\":\"https://medium.com/...\",\n    \"author\":\"Zat Rana\"\n  },\n  ...\n]\n```\n\n### Using the core API\n\nSince Stein is a REST API, there are no limitations as to which languages you can use. For this example, let's use the [Stein JavaScript Client](https://github.com/SteinHQ/JS-Client/) to obtain the data:\n\n```javascript\nconst SteinStore = require(\"stein-js-client\");\n\n// Instantiate store for spreadsheet API URL\nconst store = new SteinStore(\n  \"https://api.steinhq.com/v1/storages/5cc158079ec99a2f484dcb40\"\n);\n\n// Read Sheet1 of spreadsheet\nstore.read(\"Sheet1\").then(data =\u003e {\n  console.log(data);\n});\n\n// Logs object like ↓\n// [{title:\"Why the Best Things in Life Can’t Be Planned\",content:\"Thales of Miletus, considered ...\",link:\"https://medium.com/...\",author:\"Zat Rana\"}, {...}, ...]\n```\n\n### Using plain HTML\n\nTo simply display the data on a webpage, we don't even need JS! Using [Stein Expedite](https://docs.steinhq.com/expedite-introduction),\n\n```html\n\u003c!--- Replace the data-stein-url value with your API URL ---\u003e\n\u003cdiv\n  data-stein-url=\"http://api.steinhq.com/v1/storages/5cc158079ec99a2f484dcb40/Sheet1\"\n\u003e\n  \u003cdiv\u003e\n    \u003ch1\u003e{{title}}\u003c/h1\u003e\n    \u003ch6\u003eBy {{author}}\u003c/h6\u003e\n    \u003cp\u003e\n      {{content}}\n    \u003c/p\u003e\n    \u003cp\u003eRead on \u003ca href=\"{{link}}\"\u003eMedium\u003c/a\u003e\u003c/p\u003e\n  \u003c/div\u003e\n\u003c/div\u003e\n```\n\nHere's a minimal output of the above code.\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://docs.steinhq.com/assets/expedite-blog-posts-read.png\" alt=\"Expedite Output\" /\u003e\n\u003c/p\u003e\n\n## Contributing\n\nStein is completely open-source software, and the best part about structuring it this way is that everyone gets to own, understand, and improve it.\n\nThe main purpose of this repository is to continue to evolve the Stein Core API, making it faster and easier to use. We are grateful to the community for contributing fixes and improvements.\n\n### [Code Of Conduct](./CODE_OF_CONDUCT.md)\n\nAll participants are expected to adhere to the Code of Conduct.\n\n### [Contributing Guidelines](./CONTRIBUTING.md)\n\nRead our contributing guide to learn about what contributions we are looking for and how to propose them.\n\n## Built With\n\n- [Node.js](https://github.com/nodejs/node) + [Express](https://github.com/expressjs/express): The back-end API is an Express app. It responds to requests RESTfully in JSON.\n- [MongoDB](https://github.com/mongodb/mongo): The store for data Stein needs to function (OAuth tokens, API lists, etc.)\n\n## Partners\n\nStein officially partners with the following companies, and thanks them for their support!\n\n\u003cp\u003e\n  \u003ca href=\"https://www.digitalocean.com/\"\u003e\n    \u003cimg src=\"https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg\" height=\"32px\"\u003e\n  \u003c/a\u003e\n    \n  \u003ca href=\"https://www.gandi.net/\"\u003e\n    \u003cimg src=\"https://v4.gandi.net/static/images/illustrations/press/Gandi_logo_black.jpg\" height=\"32px\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nFor any queries regarding partnerships, reach out to [SteinHQ](mailto:hello@steinhq.com).\n\n## License\n\nThe Stein core project is [MIT licensed](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSteinHQ%2FStein","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSteinHQ%2FStein","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSteinHQ%2FStein/lists"}