|
1 | 1 | # Torrust Index Frontend
|
2 | 2 |
|
3 |
| -This repository contains the [vue-3](https://vuejs.org/) frontend web-application for the [Torrust Index](https://github.com/torrust/torrust-index) project. |
| 3 | +This repository serves as the backend for the [Torrust Index](https://github.com/torrust/torrust-index) project. |
| 4 | + |
| 5 | +It contains the [vue-3](https://vuejs.org/) frontend web application for the [Torrust Index](https://github.com/torrust/torrust-index). |
4 | 6 |
|
5 | 7 | This frontend connects using the [Torrust Index Application Interface](https://github.com/torrust/torrust-index-api-lib) to our reference [Torrust Index Backend](https://github.com/torrust/torrust-index-backend).
|
6 | 8 |
|
| 9 | + |
| 10 | + |
| 11 | +## Key Features |
| 12 | + |
| 13 | +* [X] Built with [Nuxt](https://nuxt.com/) and [Vue 3](https://vuejs.org/). |
| 14 | +* [X] Modern design |
| 15 | +* [X] Categories and tags |
| 16 | +* [X] Search |
| 17 | +* [X] Sorting |
| 18 | +* [X] Filtering |
| 19 | +* [X] Pagination |
| 20 | +* [X] Admin settings: tracker, categories, tags, etc. |
| 21 | + |
| 22 | +You can see some [screenshots](./docs/screenshots.md) of the application. |
| 23 | + |
| 24 | +## Getting Started |
| 25 | + |
| 26 | +Requirements: |
| 27 | + |
| 28 | +* Node >= 19.0.0 |
| 29 | + |
| 30 | +You can follow the [documentation](./docs/index.md) to install and use Torrust Index Frontend for development. We will improve the documentation with: |
| 31 | + |
| 32 | +* Installation guide for production. |
| 33 | +* Docker images and guides for using Torrust Index Frontend with docker for development and production. |
| 34 | + |
7 | 35 | ## Documentation
|
8 | 36 |
|
9 |
| -You can read the documentation [here](https://torrust.github.io/torrust-documentation/torrust-web-frontend/about/). |
| 37 | +You can read the documentation [here](./docs/index.md). |
| 38 | + |
| 39 | +## Contributing |
10 | 40 |
|
| 41 | +We welcome contributions from the community! |
11 | 42 |
|
12 |
| -## Contact and Contributing |
| 43 | +How can you contribute? |
13 | 44 |
|
14 |
| -We welcome new contributors. Please read our [contribution agreement](https://github.com/torrust/.github/blob/main/info/contributing.md). |
| 45 | +* Bug reports and feature requests. |
| 46 | +* Code contributions. You can start by looking at the issues labeled ["good first issues"](https://github.com/torrust/torrust-index-frontend/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). |
| 47 | +* Documentation improvements. Check the [documentation](./docs/index.md) for typos, errors, or missing information. |
| 48 | +* Participation in the community. You can help by answering questions in the [discussions](https://github.com/torrust/torrust-index-frontend/discussions). |
15 | 49 |
|
16 | 50 | Please report issues:
|
17 | 51 |
|
18 | 52 | * Torrust Index Frontend specifically: [here](https://github.com/torrust/torrust-index-frontend/issues).
|
19 | 53 | * Torrust Index in general: [here](https://github.com/torrust/torrust-index/issues).
|
20 | 54 |
|
| 55 | +Please read our [contribution agreement](https://github.com/torrust/.github/blob/main/info/contributing.md). |
| 56 | + |
| 57 | +## License |
21 | 58 |
|
22 |
| -## Credits & Sponsors |
| 59 | +The project is licensed under a dual license. See [COPYRIGHT](./COPYRIGHT). |
23 | 60 |
|
24 |
| -This project was developed by [Dutch Bits](https://dutchbits.nl) for [Nautilus Cyberneering GmbH](https://nautilus-cyberneering.de/). |
| 61 | +## Acknowledgments |
25 | 62 |
|
26 |
| -The project has been possible through the support and contribution of both Nautilus Cyberneering, its team and collaborators, as well as that of our great open source contributors. Thank you to you all! |
| 63 | +This project was a joint effort by [Nautilus Cyberneering GmbH](https://nautilus-cyberneering.de/), [Dutch Bits](https://dutchbits.nl) and collaborators. Thank you to you all! |
0 commit comments