<p align="center">
  <img src="/data/kakunin_logo.png" alt="kakunin.png" width="550"/>
</p>

<p align="center">
  <img src="/data/travis.png" alt="travis.png" width="25" />
   Current travis build:
  <a href="https://travis-ci.org/TheSoftwareHouse/Kakunin"><img src="https://travis-ci.org/TheSoftwareHouse/Kakunin.svg?branch=master" alt="build status" height="18"></a>
  &emsp;
  <img src="/data/npm.png" alt="npm.png" width="25"/> 
  Current npm version:
  <a href="https://badge.fury.io/js/kakunin"><img src="https://badge.fury.io/js/kakunin.svg" alt="npm version" height="18"></a>
</p>

<p align="center">
  <a href="#key-features">Key Features</a> •
  <a href="#documentation">Documentation</a> •
  <a href="#contributing">Contributing</a> •
  <a href="#issues">Issues</a> •
  <a href="#you-may-also-like-our-other-projects">Related</a> •
  <a href="#about-us">About us</a>
</p>

<p align="center">
  <img src="/data/pageObjectFeature.gif" alt="pageObjectFeature.gif"/>
</p>

<h1>
</h1>

### **Automated testing framework**

Kakunin is a Protractor extension created by The Software House sp. z o.o. and Takamol Holding. It allows you to write e2e test scenarios with a help of Gherkin language and JavaScript for all kind of applications - Angular, React and others.

---

### **Key Features:**

1. E2E testing
2. Performance testing
3. Parallel testing
4. Cross browser testing
5. Reports

---

### **Documentation:**

You can find documentation on the **[official page](https://kakunin.io)**.

---

### **Contributing:**

Feel free to contribute to this project! Just fork the code, make any updated and let us know!

To create a pull requests:
1. Create your a new fork
2. Create a new branch on your fork
3. Create pull requests to `next` branch (https://github.com/TheSoftwareHouse/Kakunin). Pull requests to `master` are only acceptable if it's a hotfix!
4. Make sure that the build on Travis passed (it runs build, units tests, functional tests)
5. Wait for reviews! :)

Remember to:
a. update `changelog.md`
b. tests your functionality (we got 2 layers of tests - functional and unit tests)
- `unit tests` are added as `<functionality>.spec.ts`
- `functional tests` more information available `functional-tests/README.md`
c. update documentation (more details in `/website/README.md`)

---

### **Issues:**

If you notice any issues while using, let as know on **[github](https://github.com/TheSoftwareHouse/Kakunin/issues)**.
Security issues, please sent on <a href="mailto:security.opensource@tsh.io"><b>email</b></a>

---

### **You may also like our other projects:**

- **[Babelsheet-js](https://github.com/TheSoftwareHouse/babelsheet-js)**
- **[Fogger](https://github.com/TheSoftwareHouse/fogger)**

---

### **About us:**

<p align="center">
  <a href="https://tsh.io/pl"><b>The Software House</b></a>
  &emsp;
  <img src="/data/tsh.png" alt="tsh.png" width="50" />
</p>
