{"id":22994161,"url":"https://github.com/idrinth-api-bench/documentation-website","last_synced_at":"2026-05-10T03:07:30.027Z","repository":{"id":238381148,"uuid":"796433467","full_name":"idrinth-api-bench/documentation-website","owner":"idrinth-api-bench","description":"This is the documentation website repository for a typescript framework meant to performance test anything even remotely rest-like and related tools","archived":false,"fork":false,"pushed_at":"2024-05-18T13:30:25.000Z","size":2095,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"the-one","last_synced_at":"2024-05-19T14:25:44.167Z","etag":null,"topics":["api-testing","benchmarking","documentation","documentation-website","load-testing","performance-monitoring","performance-testing","react","reactjs","rest-api-test"],"latest_commit_sha":null,"homepage":"https://idrinth-api-ben.ch","language":"TypeScript","has_issues":false,"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/idrinth-api-bench.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["idrinth"],"ko_fi":"idrinth"}},"created_at":"2024-05-05T23:00:28.000Z","updated_at":"2024-05-20T21:06:34.267Z","dependencies_parsed_at":"2024-05-06T00:20:22.434Z","dependency_job_id":"3a9c4286-399d-4a60-8fe8-cb6edf96b5ba","html_url":"https://github.com/idrinth-api-bench/documentation-website","commit_stats":null,"previous_names":["idrinth-api-bench/documentation-website"],"tags_count":0,"template":false,"template_full_name":"idrinth-api-bench/project-defaults","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idrinth-api-bench%2Fdocumentation-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idrinth-api-bench%2Fdocumentation-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idrinth-api-bench%2Fdocumentation-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idrinth-api-bench%2Fdocumentation-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/idrinth-api-bench","download_url":"https://codeload.github.com/idrinth-api-bench/documentation-website/tar.gz/refs/heads/the-one","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244868756,"owners_count":20523591,"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-testing","benchmarking","documentation","documentation-website","load-testing","performance-monitoring","performance-testing","react","reactjs","rest-api-test"],"created_at":"2024-12-15T05:17:14.065Z","updated_at":"2026-05-10T03:07:29.975Z","avatar_url":"https://github.com/idrinth-api-bench.png","language":"TypeScript","funding_links":["https://github.com/sponsors/idrinth","https://ko-fi.com/idrinth"],"categories":[],"sub_categories":[],"readme":"# @idrinth-api-bench/documentation-website\n\n## Description\n\nWebsite made using React to show the ideas behind the API benchmark\nimplementation portraying the provided README.\n\n## Installation\n\n### Read before installing\n\nYou must have a GitHub token set in your account in order to be able to\ncontribute to this project. If you try to contribute without one, you\nwon't be able to since the GitHub API will limit your access.\n\n### What are GitHub tokens?\n\nGitHub tokens are identifiers that you can set with specific rights\n(as in power of management) in your account. These tokens are required\nwhen contributing with open source so that you can be identified when\nmaking requests to the GitHub API.\n\n### How do I get a token?\n\n1. Click your profile picture on the GitHub website after logging in.\n2. In the menu that appears, click on `Settings`.\n3. Now, on the Settings screen, scroll down to the very bottom of the\npage and click on `\u003c\u003e Developer settings`.\n4. Once you're there, click on `Personal access tokens`.\n5. Now, click on `Generate new token`.\n6. You can add a note to your token as a reminder of what it\nwas created for.\n7. Set an expiration time for your token for extra safety, if you\nwish.\n8. Your token must have **only** two permissions: `public_repo` `read:org`\n9. Click on `Generate token`.\n10. Copy the token value that is generated.\n11. Create or find a file called `.env`.\n12. Inside that file, add or change the value of the variable\n`GITHUB_API_TOKEN` to the value of your token, like below.\n13. Now you can install the dependencies by typing the installation\ncommand.\n\n```ini\nGITHUB_API_TOKEN=gh_api_token_with_read_org_and_read_repo\n```\n\n### Installation command\n\n```bash\nnpm ci\n```\n\n## Running the app\n\nIf you encounter any problems with this, try checking the\n[Token tutorial](#how-do-i-get-a-token) right above this section.\n\n```bash\n# development watch mode\nnpm run dev\n\n# production mode\nnpm run start\n```\n\n## [Issues](https://github.com/idrinth-api-bench/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidrinth-api-bench%2Fdocumentation-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fidrinth-api-bench%2Fdocumentation-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidrinth-api-bench%2Fdocumentation-website/lists"}