https://github.com/piflyer/hackathon-2023

https://github.com/piflyer/hackathon-2023

a-frame easyrtc metaverse networked-aframe webrtc

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/piflyer/hackathon-2023
• Owner: Piflyer
• License: mit
• Created: 2023-01-13T23:18:55.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-22T19:55:48.000Z (about 1 year ago)
• Last Synced: 2024-10-12T16:50:50.341Z (3 months ago)
• Topics: a-frame, easyrtc, metaverse, networked-aframe, webrtc
• Language: PHP
• Homepage: https://meet.thisistim.dev/
• Size: 4.86 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hackathon-2023

[Sid](https://github.com/Sid220) and I worked on a mini metaverse that functions a video calling site. This can be used as a virtual hangout and get together for distant friends and family.

View it live [here.](https://winterwonderland.plios.tech/)

## Specs:

* Used Aframe.js and Networked Aframe

* JS based

* Lightweight enough for Raspberry Pi

## Installation:

1) Clone the project by running:

`git clone https://github.com/Piflyer/Hackathon-2023.git`

2) Install the necessary dependencies for the backend:

`cd Hackathon-2023 && npm install`

3) Run the backend on your local network:

`npm run start &`

4) Configure to use your database and node server

`cp conf.ex.php conf.php && nano conf.php`

5) Run the frontend by pointing your server of choice to the `public` directory, for example with NGINX

```nginx

server {

     root /directory/to/winterwonderland/public;

     index index.php index.html index.htm;

     server_name winterwonderland.mydomain.com;

     location / {

           try_files $uri $uri/ =404;

     }

     location ~ \.php$ {

           include snippets/fastcgi-php.conf;

           # Make sure you use your correct PHP version

           fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;

     }

    listen 80;

}

```

5) Create tables by running `db.sql`

6) (Optional) Automatically discard older rooms by running a webcron:

`curl https://interwonderland.mydomain.com/internals/purge_rooms.json.php?pass=PURGE_PASS`

## Configuration Options:

| Name            | Description                                                  |

|-----------------|--------------------------------------------------------------|

| DATABASE_SERVER | Server of the database                                       |

| DATABASE_USER   | User of the database which has write access to DATABASE_NAME |

| DATABASE_PASS   | Password of DATABASE_USER                                    |

| DATABASE_NAME   | Name of database you have created tables for                 |

| NODE_SERVER     | Server running NPM command                                   |

| PURGE_PASS      | Password used to remove older rooms                          |