{"id":22671413,"url":"https://github.com/cloudforet-io/api-doc","last_synced_at":"2025-04-19T18:11:49.507Z","repository":{"id":59281080,"uuid":"532699378","full_name":"cloudforet-io/api-doc","owner":"cloudforet-io","description":"Auto-generated APIs documentation","archived":false,"fork":false,"pushed_at":"2024-04-12T03:40:42.000Z","size":4191,"stargazers_count":10,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-12T20:31:09.145Z","etag":null,"topics":["api-doc","doc"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudforet-io.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}},"created_at":"2022-09-05T01:05:39.000Z","updated_at":"2024-04-15T02:35:13.680Z","dependencies_parsed_at":"2024-04-15T02:34:55.576Z","dependency_job_id":null,"html_url":"https://github.com/cloudforet-io/api-doc","commit_stats":null,"previous_names":[],"tags_count":215,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudforet-io%2Fapi-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudforet-io%2Fapi-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudforet-io%2Fapi-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudforet-io%2Fapi-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudforet-io","download_url":"https://codeload.github.com/cloudforet-io/api-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246175219,"owners_count":20735524,"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-doc","doc"],"created_at":"2024-12-09T16:14:58.751Z","updated_at":"2025-03-29T11:21:54.629Z","avatar_url":"https://github.com/cloudforet-io.png","language":"HTML","readme":"# Quickstart Guide of Cloudforet API Documentation\n\nThis guide covers how you can quickly get started using various tools to access Cloudforest's API Documentation which auto-generated from [API's Protobuffs](https://github.com/cloudforet-io/api)\n\n---\n# Prerequisites\n- [Hugo](https://gohugo.io/getting-started/installing/) \n- [Docker](https://docs.docker.com/get-docker/)\n- [Kubernetes](https://kubernetes.io/docs/tasks/tools/install-kubectl/) or [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) \n\n\n\nThis repository can be deployed \n- as Github Pages\n- as Docker Image\n- as Kubernetes Pod using Helm Chart\n- as Hugo Server\n\n---\n\n# Deploying as Github Pages\n[Fork](https://github.com/cloudforet-io/api-doc/fork) this repository and execute `[PUSH] Deploy Hugo to GitHub Pages` Github Actions to deploy as Github Pages.\n\n\n---\n\n# Deploying as Docker Image\nExecute following command to run as Docker Image\n\n1. Run Docker Image\n   ```\n   docker run -p 1313:1313 cloudforet/api-doc:{version}\n   ```\n---\n\n# Deploying as Kubernetes Pod using Helm Chart(Not yet supported)\nExecute following command to run as Kubernetes Pod using Helm Chart\n\n1. Add Helm Repository\n    ```\n    helm repo add cloudforet https://cloudforet-io.github.io/api-doc/deploy/helm\n    ```\n   \n2. Create Namespace\n    ```\n    kubectl create namespace api-docs\n    ```\n\n3. Install Helm Chart\n    ```\n    helm install api-docs cloudforet/cloudforet-api-docs\n    ```\n   \n---\n\n# Deploying as Hugo Server\nExecute following command to run as Hugo Server\n\n1. Clone this repository\n    ```\n    git clone https://cloudforet-io.github.io/api-doc.git\n    ```\n\n2. Update Submodule\n    ```\n    git submodule update --init --recursive\n    ```\n   \n3. Run Hugo Server\n    ```\n    hugo server --gc --minify --theme hugo-book --baseUrl=\"http://localhost:1313\"\n    ```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudforet-io%2Fapi-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudforet-io%2Fapi-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudforet-io%2Fapi-doc/lists"}