This repository serves as the web GUI for the Torrust Index project.
It contains the vue-3 frontend web application for the Torrust Index.
This web GUI connects using the Torrust Index Application Interface to our reference Torrust Index.
- Built with Nuxt and Vue 3.
- Modern design.
- Categories and tags.
- Search.
- Sorting.
- Filtering.
- Pagination.
- Admin settings: tracker, categories, tags, etc.
- Support for BitTorrent v1.
NOTE: It does not support the BitTorrent Protocol Specification v2.
You can see some screenshots of the application.
The Torrust Index GUI is deployed to DockerHub, you can run a demo immediately with the following commands:
docker run -it --publish="3000:3000/tcp" torrust/index-gui:developPlease read our container guide for more information.
podman run -it --publish="3000:3000/tcp" docker.io/torrust/index-gui:developPlease read our container guide for more information.
- Node >=
20.10.0
You can follow the documentation to install and use Torrust Index GUI for development.
There are some missing sections in the documentation like an installation guide for production. Contributions to the documentation are welcome.
# Checkout repository into a new folder:
git clone https://github.com/torrust/torrust-index-gui.git && cd torrust-index-gui
# Install dependencies
npm install
# Set up the .env file (if it doesn't exist, this is the normal behaviour with a newly cloned repo)
if ! [ -f "./.env" ]; then
cp .env.local .env
fi
# Run development server
npm run devYou can use environment variables to customize the application infrastructure settings.
NUXT_PUBLIC_API_BASE="http://localhost:3001/v1" \
NITRO_HOST="0.0.0.0" \
NITRO_PORT="3000" \
npm run devPlease read our container guide for more information.
You can run the production build in preview mode with the following:
npm install && npm run build && npm run previewThe default configuration serves the web app on http://[::]:3000.
You can read the documentation here.
We are happy to support and welcome new people to our project. Please consider our contributor guide.
This is an open-source community-supported project. We welcome contributions from the community!
How can you contribute?
- Bug reports and feature requests.
- Code contributions. You can start by looking at the issues labeled "[good first issues]".
- Documentation improvements. Check the documentation for typos, errors, or missing information.
- Participation in the community. You can help by answering questions in the discussions.
Copyright (c) 2023 The Torrust Developers.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3.
This 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 for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.
Some files include explicit copyright notices and/or license notices.
For prosperity, versions of Torrust Tracker that are older than five years are automatically granted the MIT-0 license in addition to the existing AGPL-3.0-only license.
The copyright of the Torrust Tracker is retained by the respective authors.
Contributors agree:
- That all their contributions be granted a license(s) compatible with the Torrust Trackers License.
- *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.
The Torrust-Tracker project has no copyright assignment agreement.
We kindly ask you to take time and consider The Torrust Project Contributor Agreement in full.
This project was a joint effort by Nautilus Cyberneering GmbH, Dutch Bits and collaborators. Thank you to you all!