Torrust Index Backend

---

📢Important Updates 📢

• None at the moment ACCESS ALL UPDATES

---

Index

• PROJECT DESCRIPTION
• PROJECT ROADMAP
• DOCUMENTATION
• INSTALLATION
• CONTACT & CONTRIBUTING
• CREDITS

Project Description

This repository serves as the backend for the Torrust Index project.

Roadmap

Coming soon.

Documentation

You can read the documentation here.

Installation

1. Install prerequisites:

   • Rust/Cargo - Compiler toolchain & Package Manager (cargo).

2. Clone the repository:

   git clone https://github.com/torrust/torrust-index-backend.git

3. Open the project directory and create a file called: .env:

   cd torrust-index-backend
   echo "DATABASE_URL=sqlite://data.db?mode=rwc" > .env

4. Install sqlx-cli and build the sqlite database:

   cargo install sqlx-cli
   sqlx db setup

5. Build the binaries:

   cargo build --release

6. Run the backend once to generate the config.toml file:

   ./target/release/torrust-index-backend

7. Edit the newly generated config.toml file (config.toml documentation):

   nano config.toml

8. Run the backend again:

   ./target/torrust-index-backend

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 Back End specific bugs you find to the issue tracker of this repository here

Torrust Index Front End specific issues can be submitted here.

Universal issues with the Torrust Index can be submitted here. Ideas and feature requests are welcome as well!

---

Credits & Sponsors

This project was developed by Dutch Bits for Nautilus Cyberneering GmbH.

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!