api.pokedextracker.com

The API for pokedextracker.com. It's written in Node.js using the following libraries/packages:

• Hapi - API Framework
• Joi - Data Validator
• Bookshelf - ORM
• Knex - SQL Query Builder
• Bcrypt - Password Hasher
• JWT - JSON Web Token

Install

This project is meant to be run with the version of Node.js that is referenced in .node-version, so make sure you have it installed and active when running this application. This project also relies on the yarn.lock file to lock down dependency versions, so we recommend that you use yarn instead of npm to avoid "it works on my computer" bugs that are all too common with just a package.json. Assuming you have nodenv installed, you just need to install the appropriate version and then install the dependencies:

nodenv install
cd api.pokedextracker.com
yarn

Database

This project uses PostgreSQL as its database, so you'll need to have the role and database setup. Assuming you already have it installed (either through brew on OS X or apt-get on Ubuntu), you can just run the following:

createuser -d -r -l pokedex_tracker_admin
createdb -O pokedex_tracker_admin pokedex_tracker
yarn db:migrate

Data

This repo doesn't include a way to completely load up the DB with all of the actual Pokemon data. That's only been loaded into the staging and production databases. For testing purposes and to make sure everything is functioning as expected, having that data isn't entirely necessary. You should be relying on tests and factories instead of the database state.

Tests

This project uses Mocha as the test runner, Chai BDD as our assertion library, and Istanbul to track code coverage. To run the tests locally, all you need to do is run:

yarn test

It will output the results of the test, and a coverage summary. To see a line-by-line breakdown of coverage to see what you missed, you should open ./coverage/lcov-report/index.html.

Docker

Every time we deploy this repo, we build a new Docker image and upload it to Docker Hub. We use an explicit tag with the first 7 characters of the commit hash. The server will be listening on port 8647 so if you run a container locally, make sure that traffic is forwarded to that port. For example:

docker run --rm --publish 8647:8647 --name pokedextracker-api pokedextracker/api.pokedextracker.com:$(git rev-parse --short HEAD)

Deployments

Note: you need the necessary permissions to be able to deploy.

The deploy script uses Helm and the web-app Helm chart to create a new release in the PokedexTracker Kubernetes cluster. Pass in the newly created Docker tag to deploy that version to the cluster.

yarn deploy