hackerapi.js

📚 Documentation: https://hackathon.github.io/hackerapi-js/globals.html

About

HackerAPI.js is the frontend JavaScript client that handles all interactions with Hack the North's backend (hackerapi.com). All requests from the frontend should use this library.

Usage

First, install the package:

npm install --save @hackthenorth/hackerapi-js

Then, in any file where you want to use it:

import HackerAPI from "@hackthenorth/hackerapi-js";

Testing

Currently only linting is set up, there's some old, dysfunctional tests in test.old

Adding a New Module Checklist

• Extends Base class
• Takes in a copy of itself in underscore and camelcase format
• Calls super with the appropriate special handlers in case you played around with the last step
• Module is exported
• Imported and added to parent module

Proposing a New Feature

• Work on a feature branch ideally called [first initial][last name]-[feature name] (for example mjez-activities)
• Never push directly to master – open a PR
• Before merging a PR
  • git pull origin master

Deploying a new release

• Merge master into release with a [Patch]|[Minor]|[Major] prefix

Next Year

Wanna help make this project better? Check out the SHITLIST.md for a good starting point.

Cheers

Made with ❤️ by Michal Jez with the help of the rest of the platform team.