Changes

Page history
Update home authored by Lars Florian Meiendresch's avatar Lars Florian Meiendresch
Show whitespace changes
Inline Side-by-side
home.md
View page @ 85669346
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
# `19squared` - Just more than 360 # `19squared` - Just more than 360
## Key Features # Key Features
19squared is a web application for creating and experiencing interactive 360° tours in extended reality environments. 19squared is a web application for creating and experiencing interactive 360° tours in extended reality environments.
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
* **Customisation:** Tailor tours to your specific needs and preferences. * **Customisation:** Tailor tours to your specific needs and preferences.
* **Web-Based Platform:** Accessible from any device with a web browser on smartphones, tablets, laptops, and head-mounted displays. * **Web-Based Platform:** Accessible from any device with a web browser on smartphones, tablets, laptops, and head-mounted displays.
## Quick Start Guide # Quick Start Guide
This guide will walk you through creating your first interactive tour on 19squared. This guide will walk you through creating your first interactive tour on 19squared.
...@@ -36,11 +36,11 @@ This guide will walk you through creating your first interactive tour on 19squar ...@@ -36,11 +36,11 @@ This guide will walk you through creating your first interactive tour on 19squar
**Congratulations!** You've created your first tour on 19squared. Explore the platform's other features to enhance your tours with additional images, interactive elements, and more. **Congratulations!** You've created your first tour on 19squared. Explore the platform's other features to enhance your tours with additional images, interactive elements, and more.
## Developer Guide # Developer Guide
The developer guide is a comprehensive resource for developers who want to contribute to the 19squared project. The developer guide is a comprehensive resource for developers who want to contribute to the 19squared project.
### Code Structure ## Code Structure
``` ```
🌱 interactive360vr 🌱 interactive360vr
...@@ -57,7 +57,7 @@ The developer guide is a comprehensive resource for developers who want to contr ...@@ -57,7 +57,7 @@ The developer guide is a comprehensive resource for developers who want to contr
└── 🔧 .env.template └── 🔧 .env.template
``` ```
### Installation and Docker Container ## Installation and Docker Container
After running `docker compose up -d`, the server is now running the following containers by default: After running `docker compose up -d`, the server is now running the following containers by default:
...@@ -68,7 +68,7 @@ After running `docker compose up -d`, the server is now running the following co ...@@ -68,7 +68,7 @@ After running `docker compose up -d`, the server is now running the following co
| `19sq-mariadb` | mariadb Database | `3306` | | `19sq-mariadb` | mariadb Database | `3306` |
| `19sq-ladsh` | Learning Analytics Dashboard | `2000` | | `19sq-ladsh` | Learning Analytics Dashboard | `2000` |
#### Routing Traffic ### Routing Traffic
🔄 Reverse Proxy `80/443` >> 🖥️ 19sq-nginx `5001` >> 🐍 19sq-flask `8080` >> 💾 19sq-mariadb `3306` 🔄 Reverse Proxy `80/443` >> 🖥️ 19sq-nginx `5001` >> 🐍 19sq-flask `8080` >> 💾 19sq-mariadb `3306`
...@@ -79,12 +79,12 @@ To make your application accessible, you'll want to route external traffic to th ...@@ -79,12 +79,12 @@ To make your application accessible, you'll want to route external traffic to th
* **Adding SSL certificates:** Secure the application with free Let's Encrypt certificates. * **Adding SSL certificates:** Secure the application with free Let's Encrypt certificates.
* **Managing multiple applications:** Centralize configuration for multiple containerized services. * **Managing multiple applications:** Centralize configuration for multiple containerized services.
#### Garbage Collector ### Garbage Collector
The asset management system includes a garbage collector, accessible via the endpoint `/garbage_collector`. This mechanism is designed to reclaim storage capacity by periodically purging unreferenced assets. Integrating the garbage collector into a routine cron job schedule can optimise server storage utilisation. The asset management system includes a garbage collector, accessible via the endpoint `/garbage_collector`. This mechanism is designed to reclaim storage capacity by periodically purging unreferenced assets. Integrating the garbage collector into a routine cron job schedule can optimise server storage utilisation.
For details about the development server, please refer to the project's [README](https://git.rwth-aachen.de/medialab/interactive360vr/-/blob/main/README.md) file. For details about the development server, please refer to the project's [README](https://git.rwth-aachen.de/medialab/interactive360vr/-/blob/main/README.md) file.
### Contribution Guidelines ## Contribution Guidelines
To get started as a developer, refer to the project's [CONTRIBUTING](https://git.rwth-aachen.de/medialab/interactive360vr/-/blob/main/CONTRIBUTING.md) file. It provides a detailed guide on how to contribute code, report issues, and follow best practices. To get started as a developer, refer to the project's [CONTRIBUTING](https://git.rwth-aachen.de/medialab/interactive360vr/-/blob/main/CONTRIBUTING.md) file. It provides a detailed guide on how to contribute code, report issues, and follow best practices.