{"id":20791455,"url":"https://github.com/keploy/docs","last_synced_at":"2025-04-04T06:10:04.211Z","repository":{"id":40465529,"uuid":"470303127","full_name":"keploy/docs","owner":"keploy","description":"Documentation website for Keploy","archived":false,"fork":false,"pushed_at":"2024-10-29T10:48:04.000Z","size":172714,"stargazers_count":42,"open_issues_count":6,"forks_count":129,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-29T12:44:36.722Z","etag":null,"topics":["docs","documentation","docusaurus","hacktoberfest","hacktoberfest-2023","help","javascipt","javascript","keploy","keploy-documentation","react","reactjs","tailwindcss","typescript"],"latest_commit_sha":null,"homepage":"https://keploy.io/docs","language":"JavaScript","has_issues":false,"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/keploy.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":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-15T19:27:14.000Z","updated_at":"2024-10-29T10:48:06.000Z","dependencies_parsed_at":"2023-09-27T23:27:23.993Z","dependency_job_id":"6bfa6c01-f6fc-42ca-a6ad-d59ac267ba2f","html_url":"https://github.com/keploy/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/keploy%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keploy%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keploy%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keploy%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keploy","download_url":"https://codeload.github.com/keploy/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128753,"owners_count":20888235,"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":["docs","documentation","docusaurus","hacktoberfest","hacktoberfest-2023","help","javascipt","javascript","keploy","keploy-documentation","react","reactjs","tailwindcss","typescript"],"created_at":"2024-11-17T15:44:45.147Z","updated_at":"2025-04-04T06:09:59.393Z","avatar_url":"https://github.com/keploy.png","language":"JavaScript","readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1\u003eKeploy\u003c/h1\u003e\n\u003c/div\u003e\n\u003cp style=\"text-align:center;\" align=\"center\"\u003e\n  \u003cimg align=\"center\" src=\"https://avatars.githubusercontent.com/u/92252339?s=200\u0026v=4\" height=\"30%\" width=\"30%\" /\u003e\n \u003cdiv align=\"center\"\u003e\n \u003ch1\u003eDocs Website\u003c/h1\u003e\n \u003cp\u003e\nRepository for the Keploy documentation website.\n\u003c/p\u003e\n\u003c/div\u003e\n\n**Note** :- Issue Creation is disabled on this Repository, please visit [here](https://github.com/keploy/keploy/issues/new/choose) to submit Issue.\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/keploy/docs\" alt=\"GitHub contributors\"\u003e\n\u003cimg src=\"https://img.shields.io/github/contributors/keploy/docs.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/keploy/docs\" alt=\"GitHub issues by-label\"\u003e\n\u003cimg src=\"https://img.shields.io/github/issues/keploy/docs\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://join.slack.com/t/keploy/shared_invite/zt-2poflru6f-_VAuvQfCBT8fDWv1WwSbkw\" alt=\"Slack\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/Slack-@layer5.svg?logo=slack\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://twitter.com/Keployio\" alt=\"Twitter Follow\"\u003e\n\u003cimg src=\"https://img.shields.io/twitter/follow/keploy.svg?label=Follow\u0026style=social\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/keploy/docs\" alt=\"License\"\u003e\n\u003cimg src=\"https://img.shields.io/github/license/keploy/docs.svg\" /\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n[Keploy](https://keploy.io) is a no-code testing platform that generates tests from API calls.\n\nKeploy is constantly working to improve and expand its documentation.\nSome components may change without notice.\nPage slugs (URLs), menu labels, and the location of information are a few of the items you can expect to see altered as we endeavour to give you the best experience possible.\n\nThe documentation in this repository is published to https://docs.keploy.io.\n\nIf information you are looking for seems to be missing, visit the [Keploy community](https://join.slack.com/t/keploy/shared_invite/zt-2poflru6f-_VAuvQfCBT8fDWv1WwSbkw) forum for help.\n\nPlease read the [CONTRIBUTING](/CONTRIBUTING.md) guide and the [STYLE](/STYLE.md) guide before you submit any pull requests.\n\nMaintainers and contributors to this project are expected to conduct themselves in a respectful way.\nSee the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) as a reference.\n\n## Technology Stack\n\nWe use a variety of technologies to build the web interface and support the community. They include:\n\n- [NodeJS](https://nodejs.org/)\n- [Yarn package manager](https://yarnpkg.com/)\n- [Docusaurus](https://docusaurus.io/)\n- [React](https://reactjs.org/)\n- [GitHub Actions](https://github.com/features/actions)\n\nWe use NodeJS and Yarn to install, test, and build the website. Docusaurus has been used as a static site generator to build the website. React is being utilized to build our custom component-based user interface to provide a modern look to the website. GitHub Actions manages our CI/CD pipelines and issue triage.\n\n## Installation\n\nThe Keploy documentation site uses [Docusaurus 2](https://v2.docusaurus.io/), which is a static website generator.\n\nYou can make changes locally without previewing them in the browser.\nHowever, if you want to build the site and preview changes in the browser, you need to have [Docusaurus 2 dependencies](https://v2.docusaurus.io/docs/installation/#requirements) installed.\n\nInitialize Docusaurus 2 in the repo by running [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-install) once in the root directory of the repo.\n\nNow you can build and view the site locally:\n\n```bash\nnpm install\nnpm start\n```\n\nThe command starts a local development server and opens a browser window.\n\n## Running Vale Locally for Documentation Linting\n\nTo help maintain consistency in our documentation, we use Vale, a syntax-aware linter that checks for spelling, grammar, and style issues.\n\n### Installation\n\n**Step 1: Install Vale**\n\nIf you're on macOS, you can install Vale using Homebrew:\n\n```bash\nbrew install vale\n```\n\nAlternatively, you can install Vale manually:\n\n1. Download Vale: Visit the Vale Releases page and download the latest version for your operating system.\n\n2. Install Vale:\n\n- On macOS and Linux, extract the binary, move it to /usr/local/bin, and make it executable:\n\n```bash\nsudo mv vale /usr/local/bin/\nsudo chmod +x /usr/local/bin/vale\n```\n\n- On Windows, follow the instructions in the downloaded .zip file.\n\n**Step 2: Configure Vale**\n\n1. Ensure you have the .vale.ini configuration file in the root directory.\n\n2. Check that StylesPath in .vale.ini points to the vale_styles directory (where custom styles are stored):\n\n```ini\nStylesPath = vale_styles\nMinAlertLevel = error\n```\n\n### Running Vale\n\n1. Linting Documentation: To check all markdown files in versioned_docs/version-2.0.0/ for errors, run:\n\n```bash\nvale versioned_docs/version-2.0.0/**/*.md\n```\n\n2. Review Errors:\n\n- Vale will output any issues directly in the terminal. Address these issues in the markdown files to maintain style consistency.\n\nNote: Running Vale locally helps catch issues early, ensuring a smooth review process when you submit a pull request.\n\n## Prettier\n\n1. Fork the repository\n\n\u003cbr/\u003e\n\n2. Clone the repository with the following command. Replace the {'\u003c'}GITHUB_USERNAME{'\u003e'} with your username\n\n```sh\ngit clone https://github.com/\u003cGITHUB_USERNAME\u003e/docs.git\n\n## Go into the directory containing the project\n\ncd docs\n```\n\n\u003cbr/\u003e\n\n3. Install all the dependencies\n\n```sh\nnpm install\n\n## Start the development server.\n\nnpm start\n```\n\n4. To reformat:\n\n```sh\nnpm prettier --write '**/*.{js,md}'\n```\n\n5. Check the build status:\n\n```sh\nnpm run build\n```\n\n\u003e Note: if the Build is failing, fix the changes before making PR.\n\nWhen we merge your PR, a new build automatically occurs and your changes publish to [https://keploy.io/docs](https://keploy.io/docs).\n\n## How to Get Involved?\n\nKeploy welcomes contributions to the docs website. If you have an idea for a new feature or a bug fix, please submit an issue or pull request. Our planned features can be found on our [Issue Tracker](https://github.com/keploy/keploy/issues/new/choose).\n\n## Community Support ❤️\n\n### 🤔 Questions?\n\nReach out to us. We're here to help!\n\n[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge\u0026logo=slack\u0026logoColor=white)](https://join.slack.com/t/keploy/shared_invite/zt-2poflru6f-_VAuvQfCBT8fDWv1WwSbkw)\n[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/company/keploy/)\n[![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge\u0026logo=YouTube\u0026logoColor=white)](https://www.youtube.com/channel/UC6OTg7F4o0WkmNtSoob34lg)\n[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge\u0026logo=Twitter\u0026logoColor=white)](https://twitter.com/Keployio)\n\n### 💖 Let's Build Together!\n\nWhether you're a newbie coder or a wizard 🧙‍♀️, your perspective is golden. Take a peek at our:\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeploy%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeploy%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeploy%2Fdocs/lists"}