Service for connecting to the pokemon REST API
These instructions will get you a copy of the project up and running on your local machine.
To get up and running, you will need the following tools.
To write and test code you will need NodeJS and Yarn installed. If your on a Mac, use Homebrew for installation.
brew install node
brew install yarn
Will also need TypeScript installed.
npm install -g typescript
Change to the root directory and install dependencies.
yarn
Tests can be run globally from the root directory by running yarn test
yarn test
Change to the root directory and run yarn start
yarn start
Open http://localhost:<port>/internal/api-docs in your browser to view the swagger documentation. NOTE: swagger.yaml base URL will need to be updated if PORT differs from default i.e 3000.
Port is set by environmental variable PORT. If none exists then will default to 3000.
- Theodore Jones - MrKiplin