If you would like to learn more about phant, please visit phant.io for usage & API docs.
Vagrant is a headless virtual machine that can be run on many different systems.
Vagrant is a safe and easy way to run
phant without the need to greatly
modify your current system
(see Why Vagrant?).
- Install VirtualBox
- Install Vagrant
- Install Git
git clone https://github.com/sparkfun/phant.git
cd phant && vagrant up --provision
phantis now available via http on port 8080 and telnet via port 8081
To restart phant use
vagrant provision from inside the
To stop the vagrant virtual machine use
vagrant halt from inside the
To restart vagrant use
vagrant up --provision from inside the
Once you have node.js installed, you can install phant by running
npm install -g phant from your favorite terminal.
-g (global) flag will make the
phant executable available in your
Now you can start phant:
$ phant phant http server running on port 8080 phant telnet server running on port 8081
This launches a telnet server for stream creation, and a http server for data input & output. You can now open a separate window, and you should be able to create a stream by connecting to the local telnet server.
$ telnet localhost 8081 Trying 127.0.0.1... Connected to localhost. Escape character is '^]'. .-.._ __ /` '. .-' `/ ( a \ / ( \,_ \ /| '---` |\ =| ` \ /__.-/ / | | | / / \ \ \ \_\ jgs |__|_| |_|__\ never forget. Welcome to phant! Type 'help' for a list of available commands phant>
Local using Docker / docker-compose
git clone https://github.com/idcrook/phant.git cd phant mkdir ./phant_streams docker-compose build docker-compose up # or as service: 'docker-compose start' open http://localhost:8888
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Copyright (c) 2014 SparkFun Electronics. Licensed under the GPL v3 license.