Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 3.45 KB

README.md

File metadata and controls

64 lines (45 loc) · 3.45 KB
Raw

#[node+HTML5+JS] GenScapes Live

##Concept This is an application that generates landscapes from a line-in audio input and allow numerous Public Clients, 1 Stage Client and 1 Live Client to actively or passively interact with the graphics.

Its main aim is to be used during live bands shows.

##Type of Servers (definitions)

  1. Cloud Server: managing mobile / desktop Public Clients
  2. Local Server: nodejs server managing Stage Client and Live Client

##Type of Clients (definitions)

  1. Public Client: mobile phone browser / desktop browser connected to Cloud Server
  2. Stage Client: browser app point-to-point connected to Local Server
  3. Live Client: nodejs app + browser app managing graphics and sound connected to Local Server

##Schema System Schema

##Local Installation

  1. If not yet installed: Install nodejs (installer link)
  2. Clone/Fork+Clone this repo git clone https://github.com/ricricucit/genscapes-live
  3. Run the command sudo npm install to install all project's dependencies coming from package.json

!!!!!! NOTE: You can avoid the following 2 steps if, at this point, you already know how to run Gulp and Bower otherwise, keep reading:

  1. Install Gulp globally sudo npm install -g gulp
  2. Install Bower globally sudo npm install -g bower

##Run the Application (Development)

  1. Run gulp dev to start a watch on modified dev files that needs a check or a task to run (eg. SCSS files)
  2. Open a new terminal window and run node index.js to start a nodejs server to run the app
  3. With a decent browser go to http://localhost:3000/ to act as Public Client
  4. With a decent browser go to http://localhost:3000/stage/ to act as Stage Client
  5. [TODO] With a decent browser go to http://localhost:3000/live/ to act as Projection Client [/TODO]
  • Check "node index,js Terminal window" to check for server for Server-side DEV help/log messages
  • Check "gulp watch Terminal window" to check for Client-side DEV help/log messages

##Run the Application (Production)

  1. Run gulp to start production tasks
  2. Move to the newly created /dist folder
  3. Run node index.js to start a nodejs server to run the app
  4. With a decent browser go to http://localhost:3000/ to act as Public Client
  5. With a decent browser go to http://localhost:3000/stage/ to act as Stage Client
  6. [TODO] With a decent browser go to http://localhost:3000/live/ to act as Projection Client [/TODO]
  7. If everything is working, you are ready to publish the content of the /dist folder on your nodejs hosting

Check Terminal for Server-side help/log messages

##Modify the Application

  1. For adding/removing packages & libraries, (eg. threeJS, helper scripts for node or JS, etc.) the application comes with 2 package managers: Bower mainly for web/client packages and NPM mainly for node/server packages.
  2. After adding/removing packages & libraries, modify the gulpfile.js array scripts_to_compress to update the distribution script.