$ npm install nycpokespawn-filteredThis program is designed to give you a filtered view of the @nycpokespawn Twitter account. It filters by Pokémon (so you can avoid getting notified about ones you already have) and by distance to a set of locations (so you can be notified only about Pokémon that spawn near locations you usually hang out at).
This program is written in Node.js, which you'll need to install on your computer. If you already have Node.js installed, make sure it is at least v6.5.0; if not, update.
Once you have Node.js installed, you'll need to open a terminal (Mac documentation, Windows documentation). Then install the program by typing
npm install -g nycpokespawn-filtered
This will take a while as it downloads this program from the internet. Once it's done, try to run it, by typing:
nycpokespawn-filtered
This will error, telling you that you need to set up the config file. Follow those instructions, using the below section for guidance. Once you've done all that, you can type nycpokespawn-filtered in the console again, and this time it should work!
config.sample.json to config.json.config.json.config.json.config.json's numberToText field.You can test the program after installing it by running
nycpokespawn-filtered-test
which will use the test data stored in this repository's test/fixtures/tweets.json file to run through the normal program, log what's going on, and text you if appropriate. This can be used to ensure you did the setup correctly.
Once setup is complete, do
nycpokespawn-filtered
to start the program. It will run forever, logging output for your information, and texting when appropriate.
You could leave this running on your computer, if it doesn't turn off often, or maybe you could get a cloud provider. I haven't looked into that yet, but now is really nice and easy to use, although you have to pay to keep things secret (like your API credentials).
If you want to run multiple instances (e.g., set up one for you and another for your friends), you can use multiple config files.
To do that, copy config.sample.json to multiple files, e.g. config-alice.json and config-bob.json, and fill it out differently for each person. (You can share API credentials between configs, although you might get rate limited if you share them too much.) You will want to change the configLabel field with some identifying value (e.g. their name).
Once you have the configs set up, run the program passing each config file. For example, to run an instance for Alice, do
nycpokespawn-filtered config-alice.json
If you've cloned the source repository, you can do
npm run start
to start a server which will act the same as the daemon, but visiting it will display the log file. This is helpful if deploying somewhere (like now.sh) which demands that you run a HTTP server.