@hackthenorth/quai

Quai

Quai is a testing tool built in React that's used by Hack the North for bug reporting in Jira!

Usage

Installation

Install the package in your project:

$ npm install --save @hackthenorth/quai

Setup

Before using the Quai component, you must:

1. Provide a valid HackerAPI auth token as an environment variable with key QUAI_QA_TOKEN.
2. Provide an environment variable with key QA set to truthy (1, true, etc).

Note: when used in a React app, you must prefix env variables with REACT_APP_ for it to be picked up by React.

Using component

Wherever your application structure is located, import and use the Quai component:

import Quai from "@hackthenorth/quai";
// ... your component ...
return <Quai projectEpicKey="JIRA_ISSUE_KEY" />;
// ... your component ...

projectEpicKey should be the parent issue/epic that you'd like child issues to be created under in Jira.

Development

Setup

First, clone the repo:

$ git clone https://github.com/hackathon/quai.git
$ cd quai

Running locally

To start a local dev server:

$ npm start

TODO: tests?

Tech stack

• React
• styled-components
• Jest
• Buildkite
• TypeScript