incomplete / discontinued
Experimental game to explore the border between physical and virtual space. A playground for augmented reality (or maybe augmented virtuality)
This repository is in sequel to the old "VIRTTRUHE HTML5 App", to give it a clean start and making it more scalable. Still in alpha
Click here to view the online demo.
To run it locally and as long as there is no distributed app or extra run script, you just open the file app/index.html in your browser.
- install the development dependencies (1)
- run the the build task (2)
- run the app (3)
First please make sure you have git for version commits installed and nodeJS, to run "serverside javascrip" programs on your machine. They are used for the build tasks.
When you have this, you can use your favourite git client to clone from https://github.com/gitbreaker222/virttruhe.git into your development folder. A folder virttruhe will be created.
Next you install the development dependencies into this folder. Therefor you need to open a terminal window and enter the enter the nodeJS command:
npm install --only=dev
It automatically downloads all packages listed in the file package.json into a new folder node_modules.
NodeJS has now installed the task runner gulp from the node package manager (npm) for you.
Run
gulp
in the terminal to trigger the gulp default task. An IDE like Webstorm shows these tasks usually on the left. You can also run the default task from there.
The folder app will be created/overridden with all compiled files from src_app.
Run the web server with the gulp serve task. To start it from terminal, type:
gulp serve
This will open app/index.html in your browser on localhost:3000`.
Congratulation! You are now familiar with the technology to work on modern web applications :)
virttruhe/
├── app/ ( built app for preview, completely created by gulp )
│ ├── data/
│ │ └── ( audio, img, json )
│ ├── js/
│ │ └── main.js ( concatenated scripts )
│ ├── style/
│ │ └── main.css ( compiled & concatenated sass files )
│ └── index.html ( compiled index.jade )
│
├── concept/
│ └── ( sketches, notes, designs, etc... )
│
├── src_app/ ( development directory )
│ ├── .tmp/ (riot tags get compiled into here)
│ │
│ ├── data/
│ │ └── ( audio, img, json / data )
│ │
│ ├── modules/ (pages/riot tags, js)
│ │ ├── sample_module/
│ │ │ ├── sample-module-model.js (model with logic)
│ │ │ ├── sample-module-service.js (object with service functions, e.g. fetch data)
│ │ │ └── sample-module.tag ( riot.js tag, template + controller )
│ │ ├── app.js ( root js file )
│ │ └── routes.js (manage url/page states)
│ │
│ ├── style/
│ │ ├── _sample-module.sass
│ │ └── main.sass
│ │
│ ├── favicon.ico
│ └── index.jade ... (renamed to .pug)
│
├── ( some config files )
├── gulpfile.js ( config for the build tasks )
├── package.json ( metadata for the app )
└── README.md ( this description file )
Copyright (c) 2016 Ruben La Biunda
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.