Skip to content

Commit ec42d0c

Browse files
committed
chore: updated README.md
1 parent 21507d7 commit ec42d0c

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

README.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,31 @@
1-
# Torrust Web Frontend
1+
# Torrust Index Frontend
22

3-
[![Release](https://github.com/torrust/torrust-web-frontend/actions/workflows/release.yml/badge.svg)](https://github.com/torrust/torrust-web-frontend/actions/workflows/release.yml)
3+
This repository serves as the frontend for the [Torrust Index](https://github.com/torrust/torrust) project.
44

5-
__Torrust Web Frontend__ is a Vue application where users can upload and download torrents.
6-
It shows details like seeders, leechers, files and a description of all the tracked torrents. It relies on the __Torrust Web Backend__ to function.
5+
## Documentation
6+
You can read the documentation [here](https://torrust.github.io/torrust-documentation/torrust-web-frontend/about/).
77

8-
[Documentation](https://torrust.github.io/torrust-documentation/torrust-web-frontend/about/)
8+
## Installation
9+
1. Install prerequisites:
10+
- [NodeJS/NPM](https://nodejs.org/) - NodeJS & Node Package Manager.
911

10-
## Features
11-
* [X] Built with Tailwind CSS
12-
* [X] Single Page Application
13-
* [X] Clean design
12+
2. Clone the repository:
13+
```bash
14+
git clone https://github.com/torrust/torrust-index-frontend.git
15+
```
16+
17+
3. Set the URL of the backend:
18+
```bash
19+
echo "VITE_API_BASE_URL=https://YOUR_DOMAIN/api" > .env
20+
```
21+
22+
4. Install node modules and build the frontend:
23+
```bash
24+
npm i
25+
npm run build
26+
```
27+
28+
5. Serve the newly generated `dist` folder.
1429

1530
## Contributing
16-
Please report any bugs you find to our issue tracker. Ideas and feature requests are welcome as well!
17-
Any pull request targeting existing issues would be very much appreciated.
31+
Please report any Torrust Index frontend specific bugs you find to the issue tracker of this repository. Torrust Index backend specific issues can be submitted [here](https://github.com/torrust/torrust-index-backend). Universal issues with the Torrust Index can be submitted [here](https://github.com/torrust/torrust). Ideas and feature requests are welcome as well!

0 commit comments

Comments
 (0)