Wani Kani

The Zapier CLI App for WaniKani

Developing

Built With

• Node
• ESLint
• Prettier-Eslint
• Husky
• Lint-Staged
• Chai

Prerequisites

You'll need to have the Zapier Platform CLI installed if you haven't already:

npm install -g zapier-platform-cli

Setting up Dev

Run the following commands to get started locally:

git clone [email protected]:mikesol314/zapier-platform-app-wanikani.git
cd zapier-platform-app-wanikani
npm install
git checkout -b <branchName>

Deploying / Publishing

• Right now, only I can deploy / publish this app. If you want to make a change, please submit a pull request and, if approved, I'll coordinate rolling it out and I'll update the CHANGELOG.md accordingly

Versioning

We should use SemVer for versioning. For the versions available, see the CHANGELOG.

Tests

Right now all we have are unit tests. You can run them with the command npm test or zapier test (they're synonomous).

Style guide

We use ESLint and a common set of rules developed by AirBnB with a couple of tweaks. Linting should occur automatically whenever you make a commit (see package.json for the exact things being run).

With that being said, you can run the following command to run the lint check against all of your files:

npm run lint

Or you can run this to format all of your files properly:

npm run format

Api References

REST API: https://docs.api.wanikani.com/20170710/