SkalskiP
diff --git a/‎.github/workflows/coverage.yml‎
Lines changed: 35 additions & 0 deletions b/‎.github/workflows/coverage.yml‎
Lines changed: 35 additions & 0 deletions
diff --git a/‎.github/workflows/docs.yml‎
Lines changed: 17 additions & 0 deletions b/‎.github/workflows/docs.yml‎
Lines changed: 17 additions & 0 deletions
diff --git a/‎.github/workflows/issue-greetings.yml‎
Lines changed: 39 additions & 0 deletions b/‎.github/workflows/issue-greetings.yml‎
Lines changed: 39 additions & 0 deletions
diff --git a/‎.nvmrc‎
Lines changed: 1 addition & 0 deletions b/‎.nvmrc‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎.travis.yml‎
Lines changed: 2 additions & 2 deletions b/‎.travis.yml‎
Lines changed: 2 additions & 2 deletions
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 19 additions & 0 deletions b/‎CONTRIBUTING.md‎
Lines changed: 19 additions & 0 deletions
diff --git a/‎README.md‎
Lines changed: 32 additions & 21 deletions b/‎README.md‎
Lines changed: 32 additions & 21 deletions
diff --git a/‎docker/Dockerfile‎
Lines changed: 1 addition & 1 deletion b/‎docker/Dockerfile‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎docs/export.md‎
Lines changed: 15 additions & 0 deletions b/‎docs/export.md‎
Lines changed: 15 additions & 0 deletions
diff --git a/‎docs/import.md‎
Lines changed: 15 additions & 0 deletions b/‎docs/import.md‎
Lines changed: 15 additions & 0 deletions
@@ -0,0 +1,35 @@
+name: Code coverage
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+
+      - name: Set up Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run the tests
+        run: npm test -- --coverage
+
+      - name: Upload coverage to Codecov
+        if: ${{ matrix.node-version == '10.x'}}
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
@@ -0,0 +1,17 @@
+name: Deploy documantation
+
+on: [push]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdir -p docs/img
+      - run: cp public/make-sense-ico-transparent.png docs/img/logo.png
+      - run: cp public/make-sense-ico.png docs/img/favicon.png
+      - run: mkdocs gh-deploy --force
@@ -0,0 +1,39 @@
+name: Issue greetings
+
+on: [issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/first-interaction@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-message: |
+            👋 Hello @${{ github.actor }}, thank you for your interest in make-sense - free to use online tool for labelling photos! 🏷️
+
+            ## 🐞 Bug reports
+
+            If you noticed that make-sense is not working properly, please provide us with as much information as possible. To make your life easier, we have prepared a **bug report template** containing all the relevant details. We know, we ask for a lot... However, please believe that knowing all that extra information - like the type of browser you use or the version of node you have installed - really helps us to solve your problems faster and more efficiently. 😉
+
+            ## 💬 Get in touch
+
+            If you've been trying to contact us but for some reason we haven't responded to your issue yet, don't hesitate to get back to us on [Gitter](https://gitter.im/make-sense-ai/community) or [Twitter](https://twitter.com/PiotrSkalski92).
+
+            ## 💻 Local setup
+
+            ```bash
+            # clone repository
+            git clone https://github.com/SkalskiP/make-sense.git
+
+            # navigate to main dir
+            cd make-sense
+
+            # install dependencies
+            npm install
+
+            # serve with hot reload at localhost:3000
+            npm start
+            ```
+            To ensure proper functionality of the application locally, an npm `6.x.x` and node.js `v12.x.x` versions are required. More information about this problem is available in the [#16](https://github.com/SkalskiP/make-sense/issues/16) issue.
+
@@ -0,0 +1 @@
+11.15.0
@@ -1,10 +1,10 @@
 language: node_js
 node_js:
-  - "stable"
+  - "11"
 cache:
   directories:
     - node_modules
 script:
   - npm test
   - npm run test:coverage
-  - npm run build
+  - npm run build
@@ -0,0 +1,19 @@
+# Contribution Guide
+
+### 💬 Submit Feedback
+The feedback should be submitted by creating an issue on GitHub [issues][1].
+Select the related template (bug report, feature request, or custom) and add the corresponding labels.
+
+### 🐞 Fix Bugs
+You may look through the GitHub [issues][1] for bugs.
+
+### 💡 Implement Features
+You may look through the GitHub [issues][1] for feature requests.
+
+### 🚀 Pull Requests (PR)
+- Fork the repository and create a new branch from the `develop` branch.
+- For bug fixes, add new tests. We use [jest.js][2]  to test our code.
+- Do a PR from your new branch to our `develop` branch of the original make-sense repo.
+
+[1]: https://github.com/SkalskiP/make-sense/issues/
+[2]: https://jestjs.io/
@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/SkalskiP/make-sense.svg?branch=develop)](https://travis-ci.org/SkalskiP/make-sense)
+[![codecov](https://codecov.io/gh/SkalskiP/make-sense/branch/develop/graph/badge.svg?token=lWsADbAey2)](https://codecov.io/gh/SkalskiP/make-sense)
 ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/SkalskiP/make-sense?include_prereleases)
 [![Gitter](https://badges.gitter.im/make-sense-ai/community.svg)](https://gitter.im/make-sense-ai/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
@@ -8,25 +9,27 @@
     <img width="600" src=".//public/ico/main-image-dark_alter.png" alt="Logo">
 </p>
 
-## Description
-
 [makesense.ai][1] is a free to use online tool for labelling photos. Thanks to the use of a browser it does not require any complicated installation - just visit the website and you are ready to go. It also doesn't matter which operating system you're running on - we do our best to be truly cross-platform. It is perfect for small computer vision deeplearning projects, making the process of preparing a dataset much easier and faster. Prepared labels can be downloaded  in one of multiple supported formats. The application was written in TypeScript and is based on React/Redux duo.
 
-## Motto
+## 📄 Documentation
+
+You can find out more about our tool from the newly released [documentation][14].
+
+## 💡 Motto
 
 > For AI to be free we need not just Open Source, but also a strong Open Data movement.  
 
 Andrew Ng
 
-## Sneak Peek
+## 👀 Sneak Peek
 
 <p align="center"> 
     <img width="1000" src=".//examples/demo-base.gif" alt="alfa-demo">
 </p>
 
 **Figure 1.** Basic version of the application - without AI support
 
-## Advanced AI functionalities
+## 🤖 Advanced AI functionalities
 
 [makesense.ai][1] strives to significantly reduce the time we have to spend on labeling photos. To achieve this, we are going to use many different AI models that will be able to give you recommendations as well as automate repetitive and tedious activities.
 
@@ -48,7 +51,7 @@ In the future, we also plan to add, among other things, models that classify pho
 
 **Figure 3.** PoseNet model - allows you to detect people's poses in photos, automating point labeling in some usecases
 
-## Set Up the Project Locally
+## 💻 Local Setup
 
 ```bash
 # clone repository
@@ -63,9 +66,9 @@ npm install
 # serve with hot reload at localhost:3000
 npm start
 ```
-To ensure proper functionality of the application locally, an npm `6.x.x` and node.js `v11.x.x` versions are required. More information about this problem is available in the [#16][4].
+To ensure proper functionality of the application locally, an npm `6.x.x` and node.js `v12.x.x` versions are required. More information about this problem is available in the [#16][4].
 
-## Set Up Project with Docker
+## 🐳 Docker Setup
 
 ```bash
 # Build Docker Image
@@ -82,7 +85,7 @@ docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' mak
 docker logs make_sense
 ```
 
-## Supported Keyboard Shortcuts
+## ⌨️ Keyboard Shortcuts
 
 | Functionality                      | Context  | Mac | Windows / Linux  |
 |:-----------------------------------|:--------:|:---:|:----------------:|
@@ -94,11 +97,12 @@ docker logs make_sense
 | Zoom in                            | Editor   | <kbd>⌥</kbd> + <kbd>+</kbd> | <kbd>Ctrl</kbd> + <kbd>+</kbd> |
 | Zoom out                           | Editor   | <kbd>⌥</kbd> + <kbd>-</kbd> | <kbd>Ctrl</kbd> + <kbd>-</kbd> |
 | Move image                         | Editor   | <kbd>Up</kbd> / <kbd>Down</kbd> / <kbd>Left</kbd> / <kbd>Right</kbd> | <kbd>Up</kbd> / <kbd>Down</kbd> / <kbd>Left</kbd> / <kbd>Right</kbd> |
+| Select Label                       | Editor   | <kbd>⌥</kbd> + <kbd>0-9</kbd> | <kbd>Ctrl</kbd> + <kbd>0-9</kbd> |
 | Exit popup                         | Popup    | <kbd>Escape</kbd> | <kbd>Escape</kbd> |
 
 **Table 1.** Supported keyboard shortcuts
 
-## Supported Export Formats
+## ⬆️ Export Formats
 
 |               | CSV | YOLO | VOC XML | VGG JSON | COCO JSON | PIXEL MASK |
 |:-------------:|:---:|:----:|:-------:|:--------:|:---------:|:----------:|
@@ -115,7 +119,7 @@ docker logs make_sense
 
 You can find examples of export files along with a description and schema on our [Wiki][7].
 
-## Supported Import Formats
+## ⬇️ Import Formats
 
 |               | CSV | YOLO | VOC XML | VGG JSON | COCO JSON | PIXEL MASK |
 |:-------------:|:---:|:----:|:-------:|:--------:|:---------:|:----------:|
@@ -127,15 +131,15 @@ You can find examples of export files along with a description and schema on our
 
 **Table 3.** The matrix of supported labels import formats
 
-## Privacy
+## 🔐 Privacy
 
 We don't store your images, because we don't send them anywhere in the first place.
 
-## Road Map
+## 📅 Road Map
 
 Our application is being actively developed. Check out our plans for the near future on our [Wiki][6]. If you have an idea for a new functionality, please hit us on [Twitter][3] and [Gitter][5] or create an issue where you can describe your concept. In the meantime, see what improvements we are planning for you in the future.
 
-## Tutorials
+## 🚀 Tutorials
 
 If you are just starting your adventure with deep learning and would like to learn and create something cool along the way, [makesense.ai][1] can help you with that. Leverage our bounding box labeling functionality to prepare a data set and use it to train your first state-of-the-art object detection model. Follow [instructions][12] and [examples][13] but most importantly, free your creativity.
 
@@ -145,13 +149,21 @@ If you are just starting your adventure with deep learning and would like to lea
 
 **Figure 4.** Detection of players moving around the basketball court, based on <a href="https://research.google.com/youtube8m/">YouTube-8M</a> dataset.
 
-## Contribution
+## 🏆 Contribution
+
+<p align="center"> 
+    <a href="https://github.com/SkalskiP/make-sense/graphs/contributors">
+      <img src="https://contrib.rocks/image?repo=SkalskiP/make-sense" />
+    </a>
+</p>
 
 Feel free to file [issues](https://github.com/SkalskiP/make-sense/issues) or [pull requests](https://github.com/SkalskiP/make-sense/pulls).  
 
-## Citation
+## 💬 Citation
 
-```
+Please cite Make Sense in your publications if this is useful for your research. Here is an example BibTeX entry:
+
+```BibTeX
 @MISC{make-sense,
    author = {Piotr Skalski},
    title = {{Make Sense}},
@@ -160,11 +172,9 @@ Feel free to file [issues](https://github.com/SkalskiP/make-sense/issues) or [pu
 }
 ```
 
-## License
-
-This project is licensed under the GPL-3.0 License - see the [LICENSE][2] file for details
+## 🪧 License
 
-Copyright (c) 2019-present, Piotr Skalski
+This project is licensed under the GPL-3.0 License - see the [LICENSE][2] file for details. Copyright &copy; 2019 Piotr Skalski.
 
 [1]: http://makesense.ai
 [2]: ./LICENSE
@@ -179,3 +189,4 @@ Copyright (c) 2019-present, Piotr Skalski
 [11]: https://www.tensorflow.org/lite/models/pose_estimation/overview
 [12]: https://towardsdatascience.com/chess-rolls-or-basketball-lets-create-a-custom-object-detection-model-ef53028eac7d
 [13]: https://github.com/SkalskiP/ILearnDeepLearning.py/tree/master/02_data_science_toolkit/02_yolo_object_detection
+[14]: https://skalskip.github.io/make-sense/
@@ -1,4 +1,4 @@
-FROM node:11.10-slim
+FROM node:12.10-slim
 
 RUN apt-get update && apt-get -y install git && rm -rf /var/lib/apt/lists/*
 
 
@@ -0,0 +1,15 @@
+# Export Formats
+
+|               | CSV | YOLO | VOC XML | VGG JSON | COCO JSON | PIXEL MASK |
+|:-------------:|:---:|:----:|:-------:|:--------:|:---------:|:----------:|
+| **Point**     | ✓   | ✗    | ☐       | ☐        | ☐         | ✗          |
+| **Line**      | ✓   | ✗    | ✗       | ✗        | ✗         | ✗          |
+| **Rect**      | ✓   | ✓    | ✓       | ☐        | ☐         | ✗          |
+| **Polygon**   | ☐   | ✗    | ☐       | ✓        | ✓         | ☐          |
+| **Label**     | ✓   | ✗    | ✗       | ✗        | ✗         | ✗          |
+
+**Table 1.** The matrix of supported labels export formats, where:
+
+- ✓ - supported format
+- ☐ - not yet supported format
+- ✗ - format does not make sense for a given label type  
@@ -0,0 +1,15 @@
+# Import Formats
+
+|               | CSV | YOLO | VOC XML | VGG JSON | COCO JSON | PIXEL MASK |
+|:-------------:|:---:|:----:|:-------:|:--------:|:---------:|:----------:|
+| **Point**     | ☐   | ✗    | ☐       | ☐        | ☐         | ✗          |
+| **Line**      | ☐   | ✗    | ✗       | ✗        | ✗         | ✗          |
+| **Rect**      | ☐   | ✓    | ☐       | ☐        | ✓         | ✗          |
+| **Polygon**   | ☐   | ✗    | ☐       | ☐        | ✓         | ☐          |
+| **Label**     | ☐   | ✗    | ✗       | ✗        | ✗         | ✗          |
+
+**Table 1.** The matrix of supported labels import formats, where:
+
+- ✓ - supported format
+- ☐ - not yet supported format
+- ✗ - format does not make sense for a given label type
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM node:11.10-slim`
	`1`	`+FROM node:12.10-slim`
`2`	`2`
`3`	`3`	`RUN apt-get update && apt-get -y install git && rm -rf /var/lib/apt/lists/*`
`4`	`4`