Tools for development have been added

.eslintrc.json

@@ -0,0 +1,23 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "plugin:sonarjs/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["react", "@typescript-eslint", "sonarjs"],
+  "rules": {}
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,14 +4,14 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/workflows/node.js.yml

@@ -0,0 +1,32 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [master, development]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      # - run: npm run build --if-present
+      - run: npm test
+      - run: npm run lint "--max-warnings 0"
+      - run: npm run check-format
+    # that's it for CI

.gitignore

@@ -40,6 +40,10 @@ build/Release
 # Dependency directories
 node_modules/
 jspm_packages/
+/.pnp
+.pnp.js
+
+# FIXME: some of ignores are useless
 
 # TypeScript v1 declaration files
 typings/
@@ -102,3 +106,16 @@ dist
 
 # TernJS port file
 .tern-port
+
+# specialy for react
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm test
+npm run lint "--max-warnings 0"
+npm run format:stage

.prettierignore

@@ -0,0 +1,3 @@
+# Ignore artifacts:
+build
+coverage

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "useTabs": false,
+  "singleQuote": true,
+  "arrowParens": "avoid"
+}

CONTRIBUTING.md

@@ -1,19 +1,19 @@
 # Contributing
 
 When contributing to this repository, please first discuss the change you wish to make via issue,
-email, or any other method with the owners of this repository before making a change. 
+email, or any other method with the owners of this repository before making a change.
 
 Please note we have a code of conduct, please follow it in all your interactions with the project.
 
 ## Pull Request Process
 
-1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a
    build.
-2. Update the README.md with details of changes to the interface, this includes new environment 
+2. Update the README.md with details of changes to the interface, this includes new environment
    variables, exposed ports, useful file locations and container parameters.
 3. Increase the version numbers in any examples files and the README.md to the new version that this
    Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
-4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
    do not have permission to do that, you may request the second reviewer to merge it for you.
 
 ## Code of Conduct
@@ -32,21 +32,21 @@ orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ### Our Responsibilities
@@ -81,4 +81,4 @@ Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+members of the project's leadership.

README.md

@@ -1,18 +1,35 @@
 ![Student](readme_images/student.png)
+
 # kpi_student
-The game brings us to the beginning of student life. You will start as a simple student with not a big amount of money in the new city, that is not ready for new visitors. 
+
+The game brings us to the beginning of student life. You will start as a simple student with not a big amount of money in the new city, that is not ready for new visitors.
 Game contains:
+
 - logical puzzles
 - strategic elements
 - puzzled plot
 - not definitely solutions
 - fortune
 - a bit of mystery
-- a lot of study
+- a lot of studies
 - and much more
 
 Could you survive all it's challenges? The KPI and his hostels are waiting for you.
-### Demo of game play
+
+![Interaction with boss](readme_images/boss.svg)
+
+_weekly you will be fighting with boss_
+
+### Features
+
+Our game is _**not** planned_ with **hardcoded** plot. Everyone can change it with the submission of plot fragment via our in-game submitting form.
+
+![Submission of new cool idea](readme_images/ideaForm.svg)
+
+_you create the game_
+
+### Demo of gameplay
+
 ![Image of main page](readme_images/main.svg)
 
 _The main page of screen_
@@ -22,15 +39,112 @@ _The main page of screen_
 _Example of game menu_
 
 ## Requirements
-To start an adventure you need a modern browser with __JavaScript support__ and nothing more.
+
+To start an adventure you need a modern browser with **JavaScript support** and nothing more.
+
 ## Dependencies
-We depend on [React](https://reactjs.org/) library
+
+### We depend on
+
+- [React](https://reactjs.org/) library
+- [Typescript](https://www.typescriptlang.org/) -> typization for pure JS
+
+### Development dependencies
+
+- [Jest](https://jestjs.io/) -> _testing_ library
+- [Prettier](https://prettier.io/) -> formater tool
+- [Eslint](https://eslint.org/) -> reduce common bugs with linter
+- [Husky](https://typicode.github.io/husky/#/) -> library for git hooks
+- [pretty-quick](https://www.npmjs.com/package/pretty-quick) -> for formating stage zone
+- [create-react-app](https://create-react-app.dev/docs/adding-typescript/) -> template for creating react application
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `yarn run test:watch`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn test`
+
+Launches the test runner in the CI test mode. See section [on your own environment](https://create-react-app.dev/docs/running-tests/#linux-macos-bash)
+
+### `yarn run test:watch`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn run test:coverage`
+
+Launches the test runner with coverage in the interactive watch mode.\
+See the section about [running tests with coverage](https://create-react-app.dev/docs/running-tests/#coverage-reporting) for more information.
+
+### `yarn run format`
+
+Launches [prettier](https://prettier.io/) on every file and write to drive.
+
+### `yarn run format:stage`
+
+Launches [pretty-quick](https://www.npmjs.com/package/pretty-quick) on stage files.
+
+### `yarn run check-format`
+
+Launches [prettier](https://prettier.io/) on every file and check whether they properly formatted if not exit with an error.
+
+### `yarn run lint`
+
+Runs [eslint](https://eslint.org/) against src directory
+
+### `yarn run lint:write`
+
+Runs [eslint](https://eslint.org/) against the src directory and tries to fix errors and warnings.
+
+### `yarn build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `yarn eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point, you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However, we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
 ## FAQ
+
 No question at this moment.:disappointed:
 
 ## Contributing
+
 We appreciate your help!
 
 To contribute, please read the contribution guidelines at [CONTRIBUTING.md](CONTRIBUTING.md)
+
 ## LICENSE
+
 By using code in this repository, you agree with all statements in [LICENSE file](LICENSE)