{"id":20797889,"url":"https://github.com/jbips/cozy-konnector-meetup","last_synced_at":"2025-03-12T02:13:33.492Z","repository":{"id":21269139,"uuid":"92056855","full_name":"JbIPS/cozy-konnector-meetup","owner":"JbIPS","description":"Bring your Meetup calendar into your Cozy","archived":false,"fork":false,"pushed_at":"2022-12-06T21:26:05.000Z","size":187,"stargazers_count":0,"open_issues_count":18,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-15T07:40:04.824Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JbIPS.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":"2017-05-22T13:29:26.000Z","updated_at":"2020-07-30T12:42:14.000Z","dependencies_parsed_at":"2023-01-11T21:08:41.423Z","dependency_job_id":null,"html_url":"https://github.com/JbIPS/cozy-konnector-meetup","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/JbIPS%2Fcozy-konnector-meetup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JbIPS%2Fcozy-konnector-meetup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JbIPS%2Fcozy-konnector-meetup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JbIPS%2Fcozy-konnector-meetup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JbIPS","download_url":"https://codeload.github.com/JbIPS/cozy-konnector-meetup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243141238,"owners_count":20242819,"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-11-17T16:35:44.205Z","updated_at":"2025-03-12T02:13:33.472Z","avatar_url":"https://github.com/JbIPS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[Cozy][cozy] \u003cYOUR SUPER NEW KONNECTOR NAME\u003e\n=======================================\n\nWhat's Cozy?\n------------\n\n![Cozy Logo](https://cdn.rawgit.com/cozy/cozy-guidelines/master/templates/cozy_logo_small.svg)\n\n[Cozy] is a platform that brings all your web services in the same private space. With it, your webapps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one's tracking you.\n\nWhat's this new konnector?\n--------------------------\n\nThis konnector can bring your meetup calendar into your Cozy.\n\n### Open a Pull-Request\n\nIf you want to work on this konnector and submit code modifications, feel free to open pull-requests! See the [contributing guide][contribute] for more information about how to properly open pull-requests.\n\n### Test the connector without an accessible cozy-stack\n\nIf you just want to test this connector without any cozy available.\n\nYou first need an installed [nodejs] (LTS version is fine).\n\nWe also suggest you tu use [yarn] instead of npm for node packages.\n\n```sh\nnpm install --global yarn\n```\n\nThen just run :\n\n```sh\nyarn\nyarn standalone\n```\n\nThe requests to the cozy-stack will be stubbed using the [./data/fixture.json] file as source of data\nand when cozy-client is asked to create or update data, the data will be output to the console.\nThe bills (or any file) will be saved in the ./data directory.\n\n### Run the connector linked to a cozy-stack\n\nIf you do not want to have to install the konnector on a cozy v3 to test it, you can register the\nkonnector as an OAuth application with the following commands :\n\n```sh\nyarn\nyarn dev\n```\n\nThis command will register your konnector as an OAuth application to the cozy-stack. By default,\nthe cozy-stack is supposed to be located in http://cozy.tools:8080. If this is not your case, just\nupdate the COZY_URL field in [./data/env.js].\n\nAfter that, your konnector is running but should not work since you did not specify any credentials to\nthe target service. You can do this in a [./data/env_fields.json] (you have\n[./data/env_fields.json.template] available as a template)\n\nNow run `yarn dev` one more time, it should be ok.\n\nThe files are saved in the root directory of your cozy by default.\n\n### How does the cozy-stack run the connector ?\n\nThe cozy-stack runs the connector in a rkt container to be sure it does not affect the environment.\n\nThe connector is run by calling npm start with the following envrionment variables :\n\n - COZY_CREDENTIALS needs to be the result of ```cozy-stack instances token-cli \u003cinstance name\u003e \u003cscope\u003e```\n - COZY_URL is the full http or https url to your cozy\n - COZY_FIELDS is something like :\n```javascript\n{\n  \"data\":{\n    \"attributes\":{\n      \"arguments\":{\n        \"account\":\"cf31eaef5d899404a7e8c3737c1c2d1f\",\n        \"folder_to_save\":\"folderPathId\",\n        \"slug\":\"mykonnector\"\n      }\n    }\n  }\n}\n```\n\nThe \"account\" field is the id of the record with doctype \"io.cozy.accounts\" which will be used as\nparameters for your konnector.\n\n### Build\n\nTo be able to run the connector, the cozy stack needs a connector which is built into only one\nfile, without needing to npm install it, this will be a lot faster to install.\n\nThere is a command in package.json to help you to do that : ```yarn build```\n\nThis command uses [webpack] to bundle all the code needed by your connector into one file.\n\nThis will generate an index.js file in the build directory. The expected way to deploy this built\nfile is to create a 'build' branch (or with another name)\n\n```sh\nyarn build\ngit checkout -b build   # if the build branch does not exist yet\ncp build/index.js ./\ngit add index.js\ngit ci -m \"built\"\ngit push origin build\n```\n\nAnd your konnector can now be installed using the following url :\n\ngit://github.com/cozy/cozy-konnector-\u003cyourkonnector\u003e.git#build\n\n### Maintainer\n\nThe lead maintainers for this konnector is [JbIPS](https://github.com/JbIPS)\n\n\n### Get in touch\n\nYou can reach the Cozy Community by:\n\n- Chatting with us on IRC [#cozycloud on Freenode][freenode]\n- Posting on our [Forum]\n- Posting issues on the [Github repos][github]\n- Say Hi! on [Twitter]\n\n\nLicense\n-------\n\n\u003cYOUR KONNECTOR NAME\u003e is developed by \u003cyour name\u003e and distributed under the [AGPL v3 license][agpl-3.0].\n\n[cozy]: https://cozy.io \"Cozy Cloud\"\n[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.html\n[freenode]: http://webchat.freenode.net/?randomnick=1\u0026channels=%23cozycloud\u0026uio=d4\n[forum]: https://forum.cozy.io/\n[github]: https://github.com/cozy/\n[nodejs]: https://nodejs.org/\n[twitter]: https://twitter.com/mycozycloud\n[webpack]: https://webpack.js.org\n[yarn]: https://yarnpkg.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbips%2Fcozy-konnector-meetup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjbips%2Fcozy-konnector-meetup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbips%2Fcozy-konnector-meetup/lists"}