https://github.com/vrapeutic/GardenDo-WebXR

VRapeutic's GardenDo - WebXR Version
https://github.com/vrapeutic/GardenDo-WebXR

virtual-reality vrapeutic webxr

Last synced: 2 months ago
JSON representation

VRapeutic's GardenDo - WebXR Version

Host: GitHub
URL: https://github.com/vrapeutic/GardenDo-WebXR
Owner: vrapeutic
License: gpl-3.0
Created: 2021-01-18T12:43:47.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2023-04-11T00:15:50.000Z (about 2 years ago)
Last Synced: 2024-10-24T04:26:02.261Z (7 months ago)
Topics: virtual-reality, vrapeutic, webxr
Language: JavaScript
Homepage: https://vrapeutic.github.io/https://vrapeutic.github.io/docs/garden-do-vr-module-description
Size: 8.97 MB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

GardenDo - WebXR Version.. Try it out! 🚀

## Description 📝

A plant watering exercise that is designed to address and measure the various variables of attention.

## Story 🎙

Reem/Hussien/Liza/Rich and the player will be watering plants today! , the player must water each flower and keep watering it until it fully grows and blooms! Each flower will look different, so watering each one will unleash a new character.

## Technologies Used 💻

- [A-Frame](https://aframe.io/)
- [Animation Mixer](https://www.8thwall.com/8thwall/animation-mixer-aframe)
- [AABB Colider](https://github.com/supermedium/superframe/tree/master/components/aabb-collider/)
- [SPE Particles](https://github.com/harlyq/aframe-spe-particles-component)
- [Super hands](https://github.com/wmurphyrd/aframe-super-hands-component)
- [Event set](https://www.npmjs.com/package/aframe-event-set-component)
- HTML, CSS, JavaScript

## Installation Guide 🖥

### Install and run the project locally using NPMv6

## Art
- https://drive.google.com/drive/folders/1LQ4lMQSIQvDrMPN0_zCtREJ-eHx4wuIu?usp=share_link

---

> node v14.17.2

> npm v6.14.13

- Clone the repository

```sh
git clone https://github.com/vrapeutic/GardenDoWebXR.git
cd GardenDoWebXR
```

- Install dependencies

```sh
npm install
```

- Run the project

```sh
npm run start:dev
```

- Go to the localhost URL specified in the terminal
- Congrats! You're now running and building the project locally! 🚀

### Install and run the project locally using Dockerv20

Coming soon..

### Run the project on Glitch platform

---

- Go to [Glitch](https://glitch.com/) platform
- Create an account if you don't already have one
- On your dashboard, then click **New project**, then choose the **Import from GitHub** option
- Paste the repo's full [url](https://github.com/vrapeutic/GardenDoWebXR), then click **Ok**
- You're ready to go!

### Preferred platform

---

If you are going to be using a VR Headset, then we recommend trying the app (either the [hosted version](https://gardendo-webxr.firebaseapp.com) or on [Glitch](https://glitch.com/)) on the [Oculus Browser](https://developer.oculus.com/webxr/).

For local development and testing, modern browsers could be used, where mouse and keyboard interactions will be the main source of interaction with the VR environment.

# Contributions 💌

First off, thanks for taking the time to contribute! You can check out our contribution guidelines from this [link](https://github.com/vrapeutic/GardenDoWebXR/blob/main/CONTRIBUTING.md).

Please note that this project is released with a Contributor Code of Conduct, which can be found [here](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). By participating in this project you agree to abide by its terms.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{AhmedAlassasy}
🐛 💻 🖋 🎨 🤔 🚧

_{Yahya Alaa}
🐛 💻 🎨 🤔 🚇 🧑‍🏫 📆