The SpiNet Initiative does require a few technical skills to get it properly running on your machine.
- Ensure you have node.js
- Follow the noble prereqs for your OS.
- Create a new PubNub account and channel. (You'll need this if you plan on using our Spi Net Alexa skill)
- Once the above lines are complete, clone this repo and cd into it:
git clone https://github.com/TylerSmall19/spi-net.git && cd spi-net
- Run
npm install
and follow any prompts that may appear. If you receive issues with the install process, it could be a depenency issue within the third-party node modules. Refer to the documentation for the error received or email the author listed in thepackage.json
found atspi-net/package.json
. - Create a new .env file in the root directory:
touch ./.env && open ./.env
- Declare your PubNub subscription, channel name, and publishing key variables:
# spi-net/.env
PUB_NUB_SUB=[YOUR_SUBSCRIPTION_KEY]
PUB_NUB_PUB=[YOUR_PUBLISHING_KEY]
PUB_NUB_CHANNEL=[YOUR_CHANNEL_NAME]
- run
npm start
to begin searching for drones. The console will alert you when 'flight ready'. - If you're using our accompanying Alexa Skill, configure those files with the instructions here.
If you run into issues with these commands and instructions, please open an issue or search the closed issues for similar ones.
We are currently not accepting contributions until after 1.20.2017.