Basic Installation¶
These instructions cover an instation from a release as well as from a git clone.
Credentials¶
- You’ll need an active Pokemon Trainer Club account or Google account
- Get a Google Maps Key
Downloading the Application¶
To run a copy from the latest develop
branch in git
you can clone the repository:
git clone https://github.com/PokemonGoMap/PokemonGo-Map.git
Installing Modules¶
At this point you should have the following:
- Python 2.7
- pip
- PokemonGo-Map application folder
First, open up your shell (cmd.exe
/terminal.app
) and change to the directory of PokemonGo-Map.
You can verify your installation like this:
python --version
pip --version
The output should look something like:
$ python --version
Python 2.7.12
$ pip --version
pip 8.1.2 from /usr/local/lib/python2.7/site-packages (python 2.7)
Now you can install all the Python dependencies, make sure you’re still in the directory of PokemonGo-Map:
Windows:
pip install -r requirements.txt
Linux/OSX:
sudo -H pip install -r requirements.txt
git
Version Extra Steps¶
Warning
This only applies if you are running from a git clone
.
In order to run from a git clone, you must compile the front-end assets with node. Make sure you have node installed for your platform:
- Windows/OSX (Click the Windows or Macintosh Installer respectively)
- Linux – refer to the package installation for your flavor of OS”
Once node/npm is installed, open a command window and validation your install:
node --version
npm --version
The output should look something like:
$ node --version
v4.7.0
$ npm --version
3.8.9
Once node/npm is installed, you can install the node dependencies and build the front-end assets:
npm install
# The assets should automatically build (you'd see something about "grunt build")
# If that doesn't happen, you can directly run the build process:
npm run build
Basic Launching¶
Once those have run, you should be able to start using the application, make sure you’re in the directory of PokemonGo-Map then:
python ./runserver.py --help
Read through the available options and set all the required CLI flags to start your own server. At a minimum you will need to provide a location, account login credentials, and a google maps key.
The most basic config you could use would look something like this:
python ./runserver.py -a ptc -u "USERNAME_HERE" -p "PASSWORD_HERE" \
-l "a street address or lat/lng coords here" -st 3 -k "maps key here"
Open your browser to http://localhost:5000 and your pokemon will begin to show up! Happy hunting!
Updating the Application¶
PokemonGo-Map is a very active project and updates often. You can follow the latest changes to see what’s changing.
If you are running a git
version, you can update with a few quick commands:
git pull
pip install -r requirements.txt --upgrade (Prepend sudo -H on Linux)
npm install
npm run build
IMPORTANT Some updates will include database changes that run on first startup. These can take a while to update. You should run only one runserver.py
command until you are certain that the DB has been updated. You will know almost immediatly that your DB needs updating by seing the following in the log/terminal screen Detected database version 7, updating to 8 when it’s done the log/terminal will continue as normal. This can take a while so be patient. Once it’s done you can start all your instances like you normally would.