{"id":13837584,"url":"https://github.com/port-labs/port-docs","last_synced_at":"2025-04-13T06:32:43.236Z","repository":{"id":63885600,"uuid":"482820650","full_name":"port-labs/port-docs","owner":"port-labs","description":"The open-source repo for docs.getport.io","archived":false,"fork":false,"pushed_at":"2025-04-09T13:59:34.000Z","size":169752,"stargazers_count":73,"open_issues_count":13,"forks_count":52,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-09T14:22:58.021Z","etag":null,"topics":["developer-platform","developer-portal","documentation","docusaurus-v3"],"latest_commit_sha":null,"homepage":"https://docs.getport.io","language":"JavaScript","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/port-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-04-18T11:24:05.000Z","updated_at":"2025-04-09T13:59:38.000Z","dependencies_parsed_at":"2024-04-17T10:57:09.147Z","dependency_job_id":null,"html_url":"https://github.com/port-labs/port-docs","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/port-labs%2Fport-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/port-labs%2Fport-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/port-labs%2Fport-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/port-labs%2Fport-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/port-labs","download_url":"https://codeload.github.com/port-labs/port-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248674677,"owners_count":21143760,"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":["developer-platform","developer-portal","documentation","docusaurus-v3"],"created_at":"2024-08-04T15:01:15.510Z","updated_at":"2025-04-13T06:32:38.215Z","avatar_url":"https://github.com/port-labs.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cp align=\"center\"\u003ePort Documentation\u003c/p\u003e\n  \u003ca href=\"https://docs.getport.io\"\u003e\u003cimg src=\"https://port-graphical-assets.s3.eu-west-1.amazonaws.com/Port+Logo.svg\" alt=\"Port\" width=\"15%\"\u003e\u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/port-labs/port-docs/actions/workflows/verify-docs-build.yml\"\u003e\u003cimg src=\"https://github.com/port-labs/port-docs/actions/workflows/verify-docs-build.yml/badge.svg\" alt=\"GitHub Actions status\"\u003e\u003c/a\u003e\n  \u003ca href= \"https://github.com/prettier/prettier\"\u003e\u003cimg alt=\"code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\"\u003e\u003c/a\u003e\n\n\u003c/p\u003e\n\n## Introduction\n\nPort is a Developer Platform made to make life easier for developers and DevOps in an organization, by creating a single platform that acts as a single source-of-truth for all of the infrastructure assets and operations existing in the organization's tech stack.\n\n## Port's documentation\n\nThis is the repository for Port's documentation website (available at [https://docs.getport.io](https://docs.getport.io))\n\nPort's documentation is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.\n\nOur documentation is hosted using [AWS Amplify](https://aws.amazon.com/amplify/).\n\n## Installation\n\nInstall [NodeJS](https://nodejs.org), it is recommended to use [NVM](https://github.com/nvm-sh/nvm#install--update-script) to make installation and management of different NodeJS versions on the same machine easier:\n\n```bash\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash\n```\n\nIf you prefer to install NodeJS manually, please refer to the [`.nvmrc`](./.nvmrc) file to see what version the docs are currently using.\n\nNow, clone the repository of Port's documentation and follow the instructions:\n\n### If you use `nvm`\n\n```bash\n# cd to the directory of the docs and run\nnvm install\nnvm use\nnpm install\nnpm run start\n```\n\n### If you installed NodeJS manually\n\n```bash\n# cd to the directory of the docs and run\nnpm install\nnpm run start\n```\n\nThe docs will start running locally on [https://localhost:4000](https://localhost:4000)\n\n## Contributing\n\nPort's documentation is open source because we want the documentation to be the most comprehensive resource for users to learn how to use Port. We believe that developers and DevOps professionals who use Port on a daily basis will want to contribute and help make it that comprehensive resource.\n\nIn order to learn how you can contribute to Port's documentation, read our [contributing guide](./CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fport-labs%2Fport-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fport-labs%2Fport-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fport-labs%2Fport-docs/lists"}