{"id":13815863,"url":"https://github.com/torrust/torrust-index-gui","last_synced_at":"2025-05-15T09:34:24.641Z","repository":{"id":37007009,"uuid":"499574440","full_name":"torrust/torrust-index-gui","owner":"torrust","description":"This repository serves as the frontend for the Torrust Index project.","archived":false,"fork":false,"pushed_at":"2024-11-13T06:32:38.000Z","size":5111,"stargazers_count":32,"open_issues_count":32,"forks_count":16,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2024-11-14T15:48:26.947Z","etag":null,"topics":["bittorrent","hacktoberfest","nuxt","torrent-indexer","torrents","vue"],"latest_commit_sha":null,"homepage":"https://torrust.com","language":"Vue","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/torrust.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-AGPL_3_0","code_of_conduct":null,"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-06-03T16:13:45.000Z","updated_at":"2024-10-28T16:15:49.000Z","dependencies_parsed_at":"2024-04-01T15:57:54.305Z","dependency_job_id":"ada40c41-0f62-46f3-a2e8-8219daea1641","html_url":"https://github.com/torrust/torrust-index-gui","commit_stats":null,"previous_names":["torrust/torrust-index-gui","torrust/torrust-index-frontend"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torrust%2Ftorrust-index-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torrust%2Ftorrust-index-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torrust%2Ftorrust-index-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torrust%2Ftorrust-index-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/torrust","download_url":"https://codeload.github.com/torrust/torrust-index-gui/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225342871,"owners_count":17459489,"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":["bittorrent","hacktoberfest","nuxt","torrent-indexer","torrents","vue"],"created_at":"2024-08-04T04:04:20.154Z","updated_at":"2025-05-15T09:34:24.627Z","avatar_url":"https://github.com/torrust.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"# Torrust Index GUI\n\n[![Container](https://github.com/torrust/torrust-index-gui/actions/workflows/container.yaml/badge.svg)](https://github.com/torrust/torrust-index-gui/actions/workflows/container.yaml) [![Labels](https://github.com/torrust/torrust-index-gui/actions/workflows/labels.yaml/badge.svg)](https://github.com/torrust/torrust-index-gui/actions/workflows/labels.yaml) [![Test](https://github.com/torrust/torrust-index-gui/actions/workflows/testing.yaml/badge.svg)](https://github.com/torrust/torrust-index-gui/actions/workflows/testing.yaml)\n\nThis repository serves as the web GUI for the [Torrust Index](https://github.com/torrust/torrust-index) project.\n\nIt contains the [vue-3](https://vuejs.org/) frontend web application for the [Torrust Index](https://github.com/torrust/torrust-index).\n\nThis web GUI connects using the [Torrust Index Application Interface](https://github.com/torrust/torrust-index-api-lib) to our reference [Torrust Index](https://github.com/torrust/torrust-index).\n\n![Torrust Architecture](https://raw.githubusercontent.com/torrust/.github/main/img/torrust-architecture.webp)\n\n## Key Features\n\n* [X] Built with [Nuxt](https://nuxt.com/) and [Vue 3](https://vuejs.org/).\n* [X] Modern design.\n* [X] Categories and tags.\n* [X] Search.\n* [X] Sorting.\n* [X] Filtering.\n* [X] Pagination.\n* [X] Admin settings: tracker, categories, tags, etc.\n* [X] Support for BitTorrent v1.\n\n\u003e NOTE: It does not support the [BitTorrent Protocol Specification v2][BEP_52].\n\nYou can see some [screenshots](./docs/screenshots.md) of the application.\n\n## Getting Started\n\n### Container Version\n\nThe Torrust Index GUI is [deployed to DockerHub][dockerhub], you can run a demo immediately with the following commands:\n\n#### Docker\n\n```sh\ndocker run -it --publish=\"3000:3000/tcp\" torrust/index-gui:develop\n```\n\n\u003e Please read our [container guide][containers] for more information.\n\n#### Podman\n\n```sh\npodman run -it --publish=\"3000:3000/tcp\" docker.io/torrust/index-gui:develop\n```\n\n\u003e Please read our [container guide][containers] for more information.\n\n### Development Version\n\n#### Requirements\n\n* Node \u003e= `20.10.0`\n\nYou can follow the [documentation](./docs/index.md) to install and use Torrust Index GUI for development.\n\nThere are some missing sections in the documentation like an installation guide for production. Contributions to the documentation are welcome.\n\n#### Checkout and Run\n\n```sh\n# Checkout repository into a new folder:\ngit clone https://github.com/torrust/torrust-index-gui.git \u0026\u0026 cd torrust-index-gui\n\n# Install dependencies\nnpm install\n\n# Set up the .env file (if it doesn't exist, this is the normal behaviour with a newly cloned repo)\nif ! [ -f \"./.env\" ]; then\n    cp .env.local .env\nfi\n\n# Run development server\nnpm run dev\n```\n\n#### Customization\n\nYou can use environment variables to customize the application infrastructure settings.\n\n```s\nNUXT_PUBLIC_API_BASE=\"http://localhost:3001/v1\" \\\n    NITRO_HOST=\"0.0.0.0\" \\\n    NITRO_PORT=\"3000\" \\\n    npm run dev\n```\n\n\u003e Please read our [container guide][containers] for more information.\n\n### Production Version\n\nYou can run the production build in preview mode with the following:\n\n```s\nnpm install \u0026\u0026 npm run build \u0026\u0026 npm run preview\n```\n\n### Services\n\nThe default configuration serves the web app on http://[::]:3000.\n\n## Documentation\n\nYou can read the documentation [here](./docs/index.md).\n\n## Contributing\n\nWe are happy to support and welcome new people to our project. Please consider our [contributor guide][contribution_guide].\u003c/br\u003e\nThis is an open-source community-supported project. We welcome contributions from the community!\n\n__How can you contribute?__\n\n* Bug reports and feature requests.\n* Code contributions. You can start by looking at the issues labeled \"[good first issues]\".\n* Documentation improvements. Check the [documentation][docs] for typos, errors, or missing information.\n* Participation in the community. You can help by answering questions in the [discussions].\n\n## License\n\n**Copyright (c) 2023 The Torrust Developers.**\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License][AGPL_3_0] as published by the [Free Software Foundation][FSF], version 3.\n\nThis program is distributed in the hope that it will be useful, but __WITHOUT ANY WARRANTY__; without even the implied warranty of __MERCHANTABILITY__ or __FITNESS FOR A PARTICULAR PURPOSE__. See the [GNU Affero General Public License][AGPL_3_0] for more details.\n\nYou should have received a copy of the *GNU Affero General Public License* along with this program. If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n\nSome files include explicit copyright notices and/or license notices.\n\n### Legacy Exception\n\nFor prosperity, versions of Torrust Tracker that are older than five years are automatically granted the [MIT-0][MIT_0] license in addition to the existing [AGPL-3.0-only][AGPL_3_0] license.\n\n### Contributor Agreement\n\nThe copyright of the Torrust Tracker is retained by the respective authors.\n\n__Contributors agree:__\n\n* That all their contributions be granted a license(s) __compatible__ with the [Torrust Trackers License](#license).\n* *That all contributors signal __clearly__ and __explicitly__ any other compilable licenses if they are not: *[AGPL-3.0-only with the legacy MIT-0 exception](#license)*.\n\n**The Torrust-Tracker project has no copyright assignment agreement.**\n\n*We kindly ask you to take time and consider The Torrust Project [Contributor Agreement][agreement] in full.*\n\n## Disclaimer\n\nThis software is provided solely for lawful purposes. Users must ensure compliance with all applicable laws and regulations regarding copyright and intellectual property. The developers of this software do not condone or support the use of this software for any illegal activities, including but not limited to the distribution of copyrighted, protected, or otherwise illegal content. By using this software, you agree to use it responsibly and in compliance with all legal requirements. Misuse of this software for illegal purposes may lead to legal consequences, for which the developers are not liable.\n\n## Acknowledgments\n\nThis project was a joint effort by [Nautilus Cyberneering GmbH][nautilus], [Dutch Bits][Dutch Bits] and collaborators. Thank you to you all!\n\n[AGPL_3_0]: ./LICENSE-AGPL_3_0\n[agreement]: https://github.com/torrust/.github/blob/main/info/licensing/contributor_agreement_v01.md\n[BEP_52]: https://www.bittorrent.org/beps/bep_0052.html\n[containers]: ./docs/index.md\n[contribution_guide]: https://github.com/torrust/.github/blob/main/info/contributing.md\n[discussions]: https://github.com/torrust/torrust-index-gui/discussions\n[dockerhub]: https://hub.docker.com/r/torrust/index-gui/tags\n[docs]: ./docs/index.md\n[Dutch Bits]: https://dutchbits.nl\n[FSF]: https://www.fsf.org/\n[MIT_0]: ./LICENSE-MIT_0\n[nautilus]: https://github.com/orgs/Nautilus-Cyberneering/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorrust%2Ftorrust-index-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftorrust%2Ftorrust-index-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorrust%2Ftorrust-index-gui/lists"}