{"id":19190002,"url":"https://github.com/ixoncloud/backend-component-workspace","last_synced_at":"2025-02-23T03:46:13.225Z","repository":{"id":182537587,"uuid":"630399770","full_name":"ixoncloud/backend-component-workspace","owner":"ixoncloud","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-08T06:16:03.000Z","size":25,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-04T06:29:34.852Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Makefile","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/ixoncloud.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-20T09:48:01.000Z","updated_at":"2024-10-08T06:16:07.000Z","dependencies_parsed_at":"2023-12-21T18:23:43.756Z","dependency_job_id":"124f6fb0-fedf-4604-9b43-70fc848c6396","html_url":"https://github.com/ixoncloud/backend-component-workspace","commit_stats":null,"previous_names":["ixoncloud/backend-component-workspace"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixoncloud%2Fbackend-component-workspace","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixoncloud%2Fbackend-component-workspace/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixoncloud%2Fbackend-component-workspace/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixoncloud%2Fbackend-component-workspace/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ixoncloud","download_url":"https://codeload.github.com/ixoncloud/backend-component-workspace/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240266855,"owners_count":19774075,"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-09T11:32:34.563Z","updated_at":"2025-02-23T03:46:13.195Z","avatar_url":"https://github.com/ixoncloud.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IXON Backend Component Workspace\n\nWelcome to your workspace for developing Cloud Functions for the IXON Cloud. Note that creating Cloud Functions requires you to be able to write Python code.\n\nThis workspace will contain all of your different web hosted functions. You can download this repository as a ZIP file, and check it into your preferred versioning system.\n\n## Requirements\n\n- Python 3.10 or higher (Functions are run in production with Python 3.10).\n- [zip](https://infozip.sourceforge.net/Zip.html) for building a bundle.\n- [curl](https://curl.se/) for deploying to IXON Cloud.\n- [Docker](https://www.docker.com/) for setting up a DocumentDB for development\n\n## Getting started\n\nTo get started, download this project as a ZIP, and extract it to your desired location.\n\nTo run the project, no additional commands are required, as this is automatically sets up your virtual environment and installs dependencies.\n\n```sh\nmake run\n```\n\nThis project already includes an example function, which you can find in **[this file](./functions/example.py)**. Please see [Developing Cloud Functions](https://developer.ixon.cloud/docs/tutorial-developing-a-cloud-function) to find out how you can run and test your function.\n\n\n\n## Deployment to IXON Cloud\n\n\u003e The deployment requires a **company ID** and a **page-component-template ID**. Authorisation is also required on the endpoints used. Please refer to the [Getting Started](https://developer.ixon.cloud/docs/getting-started-2) on our developer website how to obtain these.\n\nThis command creates a bundle and deploys it to IXON Cloud.\n\n```sh\nmake deploy\n```\n\nThis command requires two additional files to be created in the root of the project:\n\n- `.env`, containing the company and template id. This file can be checked into version control.\n- `.accesstoken`, containing a valid access token, this is the string of 32 characters that can be found in the `Authorization` header of an API call with the network inspector while browsing the IXON Portal. This file should not be checked into version control.\n\nExample `.env` file:\n```make\nIXON_API_COMPANY_ID=1111-2222-3333-4444-5555\nIXON_API_TEMPLATE_ID=a1b2c3d4e5f6\n```\n\nExample `.accesstoken` file:\n```\nhAeD80dCreaZanlUkzh4nPuPpBaop3ku\n```\n\n## Other commands\n\nSome other commands that may come in handy.\n\nThis commands sets up your virtual python environment without starting the ixoncdkingress.\n\n```sh\nmake py-venv-dev\n```\n\nThis commands cleans up your virtual python environment setup for this project.\n\n```sh\nmake py-distclean\n```\n\n## DocumentDB Client\n\nThis project contains a client that can interface with a Document Store. When booting up the workspace\na Docker container with a Document Store is automatically created. Every time you restart your function, the\ncontainer will be removed and your document store reset.\n\nTo read more about how to use the document store please refer to: [Using the Document Store](https://developer.ixon.cloud/docs/document-store)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fixoncloud%2Fbackend-component-workspace","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fixoncloud%2Fbackend-component-workspace","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fixoncloud%2Fbackend-component-workspace/lists"}