1.8.0-alpha relese (#197)

* Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats * README.md update (#78) (#79) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> * add cross hair (#90) * Piotr | Line labels creation and export (#89) * initial changes: adding line labels to redux + addling line tab to right side navigation bar * adding new lines and base rendering * up * line style + snapping to rect added * highlight logic added * line rendering engine is working * line rendering engine update + marking line labeled images added * serializing to CSV * up * after PR * after PR * quick fix * Piotr | Image recognition (#92) * image recognition initial commit * setup before image recognition tagging * base tag assignment added * default screen when empty label list * image recognition added * after CR * 1.6.0-alpha relese merge (#94) * README.md update (#78) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats Co-authored-by: Fatih Baltacı <[email protected]> * 1.6.0-alpha relese merge (#93) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats * README.md update (#78) (#79) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> * add cross hair (#90) * Piotr | Line labels creation and export (#89) * initial changes: adding line labels to redux + addling line tab to right side navigation bar * adding new lines and base rendering * up * line style + snapping to rect added * highlight logic added * line rendering engine is working * line rendering engine update + marking line labeled images added * serializing to CSV * up * after PR * after PR * quick fix * Piotr | Image recognition (#92) * image recognition initial commit * setup before image recognition tagging * base tag assignment added * default screen when empty label list * image recognition added * after CR Co-authored-by: PLE12366003 <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: PLE12366003 <[email protected]> * Update README.md * Update README.md * Update README.md * Add files via upload * Update README.md * Update README.md * Update README.md * MS-86 Coco format suppport (#107) * up * save refactor * coco exporter in progress * coco exporter in progress * Disable browser back buttons during labelling (#106) * done * up * Piotr | MS-96 | Can image suppored by multi labels (#109) * initial refactor * refactor in progress * update * csv export working * export tags as json Co-authored-by: PLE12366003 <[email protected]> * Update README.md * Piotr | MS-XXX | Import coco labels from file (#111) * initial refactor * initial changes * export popup refactored * refactor continues * style changes * base import popup added * new feature placeholder added * hide import button * up * drop zone in place * up * bug fixing cleanup * loading mechanism prepared * update * more tests and more refactor * base import created * almost done * basic error handling * done * done * Update README.md * Update README.md * quick fix * Update README.md * Piotr | MS-XXX | Import labels yolo format (#114) * initial refactor * popup prepared for other file formats * fix * fix * loading of yolo files in place * bug fix * loading labels from file * up * up * refactor * tests refactor * filtering file data * filterFilesData tests added * up * up * done * working code * up * after PR, part 1 * YOLOImporter refactor done * YOLOImporter refactor done * Piotr | MS-XXX | Drop down menu (#117) * initial work on dropdown * style and base actions * up * up * up * up * almost done * after PR * update dependencies fixing vulnerabilities (#119) * Resolves issue #44 (#120) * Resolves issue #44 * Abstracts handleKeyUp function in TextInput * Rename props to onKeyUp * Update README.md * up * 1.7.0-alpha relese (#122) (#123) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats * README.md update (#78) (#79) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> * add cross hair (#90) * Piotr | Line labels creation and export (#89) * initial changes: adding line labels to redux + addling line tab to right side navigation bar * adding new lines and base rendering * up * line style + snapping to rect added * highlight logic added * line rendering engine is working * line rendering engine update + marking line labeled images added * serializing to CSV * up * after PR * after PR * quick fix * Piotr | Image recognition (#92) * image recognition initial commit * setup before image recognition tagging * base tag assignment added * default screen when empty label list * image recognition added * after CR * 1.6.0-alpha relese merge (#94) * README.md update (#78) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats Co-authored-by: Fatih Baltacı <[email protected]> * 1.6.0-alpha relese merge (#93) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats * README.md update (#78) (#79) * Merge pull request #70 from SkalskiP/develop (#71) * new gif with ssd and posenet * Add Docker Support (#74) * add Dockerfile for make-sense * Update README for Docker * README updated * README updated with docker logs * readme updated * Update Dockerfile * Update README.md * basic stats Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> * add cross hair (#90) * Piotr | Line labels creation and export (#89) * initial changes: adding line labels to redux + addling line tab to right side navigation bar * adding new lines and base rendering * up * line style + snapping to rect added * highlight logic added * line rendering engine is working * line rendering engine update + marking line labeled images added * serializing to CSV * up * after PR * after PR * quick fix * Piotr | Image recognition (#92) * image recognition initial commit * setup before image recognition tagging * base tag assignment added * default screen when empty label list * image recognition added * after CR Co-authored-by: PLE12366003 <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: PLE12366003 <[email protected]> * Update README.md * Update README.md * Update README.md * Add files via upload * Update README.md * Update README.md * Update README.md * MS-86 Coco format suppport (#107) * up * save refactor * coco exporter in progress * coco exporter in progress * Disable browser back buttons during labelling (#106) * done * up * Piotr | MS-96 | Can image suppored by multi labels (#109) * initial refactor * refactor in progress * update * csv export working * export tags as json Co-authored-by: PLE12366003 <[email protected]> * Update README.md * Piotr | MS-XXX | Import coco labels from file (#111) * initial refactor * initial changes * export popup refactored * refactor continues * style changes * base import popup added * new feature placeholder added * hide import button * up * drop zone in place * up * bug fixing cleanup * loading mechanism prepared * update * more tests and more refactor * base import created * almost done * basic error handling * done * done * Update README.md * Update README.md * quick fix * Update README.md * Piotr | MS-XXX | Import labels yolo format (#114) * initial refactor * popup prepared for other file formats * fix * fix * loading of yolo files in place * bug fix * loading labels from file * up * up * refactor * tests refactor * filtering file data * filterFilesData tests added * up * up * done * working code * up * after PR, part 1 * YOLOImporter refactor done * YOLOImporter refactor done * Piotr | MS-XXX | Drop down menu (#117) * initial work on dropdown * style and base actions * up * up * up * up * almost done * after PR * update dependencies fixing vulnerabilities (#119) * Resolves issue #44 (#120) * Resolves issue #44 * Abstracts handleKeyUp function in TextInput * Rename props to onKeyUp * Update README.md * up Co-authored-by: PLE12366003 <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Augusto L C Schnorr <[email protected]> Co-authored-by: PLE12366003 <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Augusto L C Schnorr <[email protected]> * Implement hot keys (#134) * Added hotkeys for first 10 labels * updated readme Co-authored-by: Jordan Wagner <[email protected]> * Change Manifest.json to reflect MakeSense Name (#145) * Change Manifest.json to reflect MakeSense Name * Update manifest.json * Update README.md * Update README.md * Fix importing images and labels with filenames with multiple dots (#160) * fix importing images and labels with filenames with multiple dots * fix typo (all test passing) * removed comments from FileUtils * added unit tests for filenames with multiple dots * fix develop build (#162) * test .nvmrc * test .node js 11 * small fixes * feature/msb-001-add_automatic_response_to_new_issues_using_github_actions (#173) * Bump path-parse from 1.0.6 to 1.0.7 (#170) Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.6 to 1.0.7. - [Release notes](https://github.com/jbgutierrez/path-parse/releases) - [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7) --- updated-dependencies: - dependency-name: path-parse dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feature/msb-001-add_automatic_response_to_new_issues_using_github_actions_2 (#182) * feature/msb-002-add_code-cov_integration (#184) * feature/msb-002-add_code-cov_integration * upload test results to code-cov * add code-cov badge to README.md * feature/151_add_description_about_each_file_type (#185) * feature/151_add_description_about_each_file_type * gh action update * update documentation structure * initial documentation * initial documentation 2 * initial documentation 3 * initial documentation 4 * initial documentation 5 * initial documentation 6 * initial documentation 7 * initial documentation 8 * initial documentation 9 * initial documentation 10 * initial documentation 11 * initial documentation 12 * initial documentation 13 * feature/issue-171_invalid_YOLO_annotations_exported_for_bboxes_on_the… (#188) * feature/issue-171_invalid_YOLO_annotations_exported_for_bboxes_on_the_edge_of_an_image * done * feature/msb-003-bump_make-sense_dependencies (#189) * feature/msb-003-bump_make-sense_dependencies * package-lock.json * Bump url-parse from 1.4.7 to 1.5.3 (#179) Bumps [url-parse](https://github.com/unshiftio/url-parse) from 1.4.7 to 1.5.3. - [Release notes](https://github.com/unshiftio/url-parse/releases) - [Commits](unshiftio/url-parse@1.4.7...1.5.3) --- updated-dependencies: - dependency-name: url-parse dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump dns-packet from 1.3.1 to 1.3.4 (#178) Bumps [dns-packet](https://github.com/mafintosh/dns-packet) from 1.3.1 to 1.3.4. - [Release notes](https://github.com/mafintosh/dns-packet/releases) - [Changelog](https://github.com/mafintosh/dns-packet/blob/master/CHANGELOG.md) - [Commits](mafintosh/dns-packet@v1.3.1...v1.3.4) --- updated-dependencies: - dependency-name: dns-packet dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump color-string from 1.5.3 to 1.6.0 (#177) Bumps [color-string](https://github.com/Qix-/color-string) from 1.5.3 to 1.6.0. - [Release notes](https://github.com/Qix-/color-string/releases) - [Changelog](https://github.com/Qix-/color-string/blob/master/CHANGELOG.md) - [Commits](https://github.com/Qix-/color-string/commits/1.6.0) --- updated-dependencies: - dependency-name: color-string dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix/dockerfile can be built with current develop branch (#191) * Update README.md * Update issue-greetings.yml * Update mkdocs.yml * Update README.md * Update README.md * initial integration with GTM (#192) * feature/141_per-class_coloration (#190) * initial commit - refactor + color palette list + color added to LabelName type + color initiation * use material ui text field * label creation and edit is working * refresh button is working * color labels work in progress * render settings refactor * render rect works * done * feature/msb-004_orchestrated_error_reporting_system (#193) * initial commit - refactor + color palette list + color added to LabelName type + color initiation * use material ui text field * label creation and edit is working * refresh button is working * color labels work in progress * render settings refactor * render rect works * done * initial commit with Redux store setup * initial notifications view plugin * notifications view is ready to use * refactor * refactor 2 * Update README.md * Update README.md * feature/167_click_outside_the_image_line (#194) * feature/164_respect_directory_structure_or_at_least_provide_warning (#195) * initial refactor * empty labels validation * non unique labels validation * issue/87_tooltips_for_action_bar_buttons (#196) * tf.js models fix Co-authored-by: Piotr Skalski <[email protected]> Co-authored-by: PLE12366003 <[email protected]> Co-authored-by: Fatih Baltacı <[email protected]> Co-authored-by: Augusto L C Schnorr <[email protected]> Co-authored-by: jaaywags <[email protected]> Co-authored-by: Jordan Wagner <[email protected]> Co-authored-by: Muhammad Fahmi Rasyid <[email protected]> Co-authored-by: Héctor A <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: David Bensoussan <[email protected]>
SkalskiP · Sep 6, 2021 · 8f418fc · 8f418fc
1 parent fdab9a3
commit 8f418fc
Show file tree

Hide file tree

Showing 117 changed files with 12,056 additions and 7,198 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -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 }}
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -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
diff --git a/.github/workflows/issue-greetings.yml b/.github/workflows/issue-greetings.yml
@@ -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.
+
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+11.15.0
diff --git a/.travis.yml b/.travis.yml
@@ -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
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -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/
diff --git a/README.md b/README.md
@@ -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/
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -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/*
 

diff --git a/docs/export.md b/docs/export.md
@@ -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  
diff --git a/docs/import.md b/docs/import.md
@@ -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  
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,24 @@
+<h1 align="center">makesense.ai</h1>
+
+<p align="center"> 
+    <img width="120" src="https://user-images.githubusercontent.com/26109316/131229187-1d93dc42-963c-440e-8f38-53ee72a2260d.png" alt="make-sense">
+</p>
+
+
+[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.
+
+## 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.
+
+* [SSD model][8] pretrained on the [COCO dataset][9], which will do some of the work for you in drawing bboxes on photos and  also (in some cases) suggest a label.
+* [PoseNet model][11] is a vision model that can be used to estimate the pose of a person in an image or video by estimating where key body joints are.
+
+In the future, we also plan to add, among other things, models that classify photos, detect characteristic features of faces as well as whole faces. The engine that drives our AI functionalities is [TensorFlow.js][10] - JS version of the most popular framework for training neural networks. This choice allows us not only to speed up your work but also to care about the privacy of your data, because unlike with other commercial and open source tools, your photos do not have to be transferred to the server. This time AI comes to your device!
+
+
+[1]: http://makesense.ai
+[8]: https://arxiv.org/abs/1512.02325
+[9]: http://cocodataset.org
+[10]: https://www.tensorflow.org/js
+[11]: https://www.tensorflow.org/lite/models/pose_estimation/overview
diff --git a/docs/local-setup.md b/docs/local-setup.md
@@ -0,0 +1,18 @@
+# Set Up the Project Locally
+
+```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, npm `6.x.x` and node.js `v11.x.x` versions are required. More information about this problem is available in the [#16][1].
+
+[1]: https://github.com/SkalskiP/make-sense/issues/16
diff --git a/docs/shortcuts.md b/docs/shortcuts.md
@@ -0,0 +1,14 @@
+# Keyboard Shortcuts
+
+| Functionality                      | Context  | Mac | Windows / Linux  |
+|:-----------------------------------|:--------:|:---:|:----------------:|
+| Polygon autocomplete               | Editor   | <kbd>Enter</kbd> | <kbd>Enter</kbd> |
+| Cancel polygon drawing             | Editor   | <kbd>Escape</kbd> | <kbd>Escape</kbd> |
+| Delete currently selected label    | Editor   | <kbd>Backspace</kbd> | <kbd>Delete</kbd> |
+| Load previous image                | Editor   | <kbd>⌥</kbd> + <kbd>Left</kbd> | <kbd>Ctrl</kbd> + <kbd>Left</kbd> |
+| Load next image                    | Editor   | <kbd>⌥</kbd> + <kbd>Right</kbd> | <kbd>Ctrl</kbd> + <kbd>Right</kbd> |
+| 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> |