{"id":20063415,"url":"https://github.com/vanilla-os/chronos-frontend","last_synced_at":"2025-03-02T10:26:55.450Z","repository":{"id":190407998,"uuid":"682552595","full_name":"Vanilla-OS/chronos-frontend","owner":"Vanilla-OS","description":"A frontend in Vue.js for the Chronos documentation server.","archived":false,"fork":false,"pushed_at":"2025-02-27T16:04:53.000Z","size":606,"stargazers_count":7,"open_issues_count":10,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-27T21:10:06.697Z","etag":null,"topics":["chronos","documentation","frontend","hacktoberfest","vanillaos","website"],"latest_commit_sha":null,"homepage":"https://docs.vanillaos.org","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Vanilla-OS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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},"funding":{"github":"vanilla-os","liberapay":"fabricators"}},"created_at":"2023-08-24T12:21:45.000Z","updated_at":"2025-02-27T16:04:56.000Z","dependencies_parsed_at":"2023-12-07T09:27:02.287Z","dependency_job_id":"694c5580-d5cc-4f7f-9e76-2bb69f2a4f83","html_url":"https://github.com/Vanilla-OS/chronos-frontend","commit_stats":null,"previous_names":["vanilla-os/chronos-frontend"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fchronos-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fchronos-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fchronos-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fchronos-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Vanilla-OS","download_url":"https://codeload.github.com/Vanilla-OS/chronos-frontend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241491181,"owners_count":19971415,"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":["chronos","documentation","frontend","hacktoberfest","vanillaos","website"],"created_at":"2024-11-13T13:42:07.766Z","updated_at":"2025-03-02T10:26:55.427Z","avatar_url":"https://github.com/Vanilla-OS.png","language":"Vue","funding_links":["https://github.com/sponsors/vanilla-os","https://liberapay.com/fabricators"],"categories":[],"sub_categories":[],"readme":"# Chronos Vue.js frontend\n\nA frontend in Vue.js for the [Chronos](https://github.com/vanilla-os/chronos)\ndocumentation server.\n\n## Configuration\n\nThe configuration is done in the `public/chronos.json` file. The following\noptions are available:\n\n```json\n{\n  \"title\": \"Chronos Documentation\",\n  \"logoTitle\": \"Documentation\",\n  \"logoUrl\": \"/logo.svg\",\n  \"description\": \"A frontend in Vue.js for the Chronos documentation server.\",\n  \"baseUrl\": \"http://localhost:5173\",\n  \"chronosCollections\": [\n    [\n      {\n        \"shortName\": \"docs\",\n        \"title\": \"Docs\",\n        \"url\": \"http://localhost:8080/documentation\",\n        \"description\": \"Read the technical documentation for the Awesome project.\"\n      }\n    ],\n    [\n      {\n        \"shortName\": \"handbook\",\n        \"title\": \"Handbook\",\n        \"url\": \"http://localhost:8080/handbook\",\n        \"description\": \"Are you a new user? Read the handbook to learn how to use the Awesome project.\"\n      }\n    ]\n  ],\n  \"extraLinks\": [\n    [\n      {\n        \"url\": \"https://github.com/vanilla-os/Chronos\",\n        \"name\": \"Source Code\"\n      }\n    ]\n  ]\n}\n```\n\nthe following optional are available for collections:\n\n- `editUrl`: the URL to the edit page of the collection, it must contain the\n  `{{lang}}` and `{{slug}}` placeholders, for example:\n  `https://github.com/Vanilla-OS/documentation/blob/main/articles/{{lang}}/{{slug}}.md`\n\nyou can also generate the configuration file using the `npm run generate-config`\ncommand, by setting the following environment variables:\n\n- `CHRONOS_TITLE`\n- `CHRONOS_LOGO_TITLE`\n- `CHRONOS_LOGO_URL`\n- `CHRONOS_DESCRIPTION`\n- `CHRONOS_BASE_URL`\n- `CHRONOS_COLLECTION*` (where \\* is a number)\n- `CHRONOS_EXTRA_LINK*` (where \\* is a number)\n\nfor example:\n\n```bash\nCHRONOS_TITLE='Chronos Documentation' \\\nCHRONOS_LOGO_TITLE='Documentation' \\\nCHRONOS_LOGO_URL='/logo.svg' \\\nCHRONOS_DESCRIPTION='A frontend in Vue.js for the Chronos documentation server.' \\\nCHRONOS_BASE_URL='http://localhost:5173' \\\nCHRONOS_COLLECTION_1='[{\"shortName\": \"docs\", \"title\": \"Docs\", \"url\": \"http://localhost:8080/documentation\", \"description\": \"Read the technical documentation for the Awesome project.\"}]' \\\nCHRONOS_COLLECTION_2='[{\"shortName\": \"handbook\", \"title\": \"Handbook\", \"url\": \"http://localhost:8080/handbook\", \"description\": \"Are you a new user? Read the handbook to learn how to use the Awesome project.\"}]' \\\n# add more collections here\nCHRONOS_EXTRA_LINK_1='[{\"url\": \"https://github.com/vanilla-os/Chronos\", \"name\": \"Source Code\"}]' \\\n# add more extra links here\n```\n\n## Development\n\nTo start the development server, run the following command:\n\n```bash\npnpm dev\n```\n\n## Generate Configuration\n\nTo generate the configuration file, run the following command:\n\n```bash\npnpm generate-config\n```\n\n## Production\n\nTo build the production version, run the following command:\n\n```bash\npnpm build\n```\n\n### Docker\n\nTo deploy the production version using Docker, run the following command:\n\n```bash\ndocker pull ghcr.io/vanilla-os/chronos-fe:main\ndocker run -d -p 6090:80 ghcr.io/vanilla-os/chronos-fe:main \\\n  -e CHRONOS_TITLE='Chronos Documentation' \\\n  -e CHRONOS_LOGO_TITLE='Documentation' \\\n  -e CHRONOS_LOGO_URL='/logo.svg' \\\n  -e CHRONOS_DESCRIPTION='A frontend in Vue.js for the Chronos documentation server.' \\\n  -e CHRONOS_BASE_URL='http://localhost:5173' \\\n  -e CHRONOS_COLLECTION_1='[{\"shortName\": \"docs\", \"title\": \"Docs\", \"url\": \"http://localhost:8080/documentation\", \"description\": \"Read the technical documentation for the Awesome project.\"}]' \\\n  -e CHRONOS_COLLECTION_2='[{\"shortName\": \"handbook\", \"title\": \"Handbook\", \"url\": \"http://localhost:8080/handbook\", \"description\": \"Are you a new user? Read the handbook to learn how to use the Awesome project.\"}]' \\\n  # add more collections here\n  -e CHRONOS_EXTRA_LINK_1='[{\"url\": \"https://github.com/vanilla-os/Chronos\", \"name\": \"Source Code\"}]' \\\n  # add more extra links here\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanilla-os%2Fchronos-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanilla-os%2Fchronos-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanilla-os%2Fchronos-frontend/lists"}