Merge pull request #33 from torrust/32-readme-review-and-adapt-to-the-torrust-index-format

Type: Documentation

Author: cgbosse

README.md

@@ -1,31 +1,87 @@
-# Torrust Index Frontend
+# Torrust Index Front End
+
+![README HEADER](./img/Torrust_Repo_FrontEnd_Readme_Header-20220615.jpg)
+
+![Open Source](https://badgen.net/badge/Open%20Source/100%25/DA2CE7)
+![Cool](https://badgen.net/badge/Cool/100%25/FF7F50)
+
+![Nautilus Sponsored](https://badgen.net/badge/Sponsor/Nautilus%20Cyberneering/red)
+
+---
+
+## 📢Important Updates 📢
+
+- None at the moment [ACCESS ALL UPDATES](https://github.com/torrust/torrust-index-frontend/wiki/Project-Updates)
+
+---
+---
+
+## Index
+
+- [PROJECT DESCRIPTION](#project-description)
+- [PROJECT ROADMAP](#project_roadmap)
+- [DOCUMENTATION](#documentation)
+- [INSTALLATION](#installation)
+- [CONTACT](#contact_and_contributing)
+- [CREDITS](#credits)
+
+## Project Description
+
 This repository serves as the frontend for the [Torrust Index](https://github.com/torrust/torrust-index) project.
 
+### Roadmap
+
+*Coming soon.*
+
 ## Documentation
+
 You can read the documentation [here](https://torrust.github.io/torrust-documentation/torrust-web-frontend/about/).
 
 ## Installation
+
 1. Install prerequisites:
-- [NodeJS/NPM](https://nodejs.org/) - NodeJS & Node Package Manager.
+    - [NodeJS/NPM](https://nodejs.org/) - NodeJS & Node Package Manager.
 
 2. Clone the repository:
-```bash
-git clone https://github.com/torrust/torrust-index-frontend.git
-```
+
+    ```bash
+    git clone https://github.com/torrust/torrust-index-frontend.git
+    ```
 
 3. Set the URL of the backend:
-> Replace YOUR_BACKEND_URL
-```bash
-echo "VITE_API_BASE_URL=YOUR_BACKEND_URL" > .env
-```
+    > Replace YOUR_BACKEND_URL
+
+    ```bash
+    echo "VITE_API_BASE_URL=YOUR_BACKEND_URL" > .env
+    ```
 
 4. Install node modules and build the frontend:
-```bash
-npm i
-npm run build
-```
+
+    ```bash
+    npm i
+    npm run build
+    ```
 
 5. Serve the newly generated `dist` folder.
 
-## Contributing
-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-index). Ideas and feature requests are welcome as well!
+## Contact and Contributing
+
+Feel free to contact us via:
+
+Message `Warm Beer#3352` on Discord or email `[email protected]`.
+
+or
+
+Please make suggestions and report any **Torrust Index Front End** specific bugs you find to the issue tracker of this repository [here](https://github.com/torrust/torrust-index-frontend/issues)
+
+**Torrust Index Back End** specific issues can be submitted [here](https://github.com/torrust/torrust-index-backend/issues).
+
+Universal issues with the **Torrust Index** can be submitted [here](https://github.com/torrust/torrust-index/issues). Ideas and feature requests are welcome as well!
+
+---
+
+## Credits & Sponsors
+
+This project was developed by [Dutch Bits](https://dutchbits.nl) for [Nautilus Cyberneering GmbH](https://nautilus-cyberneering.de/).
+
+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!