````
______ _____ _____ _____
| ___ \ _ | __ \ _ |
| |_/ / | | | | \/ | | | ___ ___ _ ____ _____ _ __
| __/| | | | | __| | | |/ __|/ _ \ '__\ \ / / _ \ '__|
| | \ \_/ / |_\ \ \_/ /\__ \ __/ | \ V / __/ |
\_| \___/ \____/\___/ |___/\___|_| \_/ \___|_|
````
# Getting started
## Setup
Copy and rename ``cfg.js.example`` to ``cfg.js``.
Open ``cfg.js`` and fill the following fields:
````js
DOWNLOAD_PROVIDER: "GOOGLE";
DOWNLOAD_USERNAME: "USERNAME";
DOWNLOAD_PASSWORD: "PASSWORD";
````
## Tunneling setup
The pokemon go app traffic has to get forwarded manually to this custom server. To do so, download [rastapasta](https://github.com/rastapasta)'s [Pokemon Go Xposed](https://github.com/rastapasta/pokemon-go-xposed/releases) app and follow the installation instructions [here](https://github.com/rastapasta/pokemon-go-xposed#how-to-use-it).
## Database setup
To setup a database connection, open ``cfg.js`` and change the database login credentials:
````js
MYSQL_PORT: 3306,
MYSQL_HOST_IP: "127.0.0.1",
MYSQL_DB_NAME: "pogosql",
MYSQL_USERNAME: "root",
MYSQL_PASSWORD: "",
````
The required database tables get generated automatically.
## Server setup
You need at minimum [Node.js](https://nodejs.org/en/) version 6.x.
Depending on your OS, you need to run either ``run-linux.sh`` or ``run-windows.bat`` from the root folder.