Merge pull request #161 from ani-team/dev

v.0.1.X

.env

@@ -2,5 +2,16 @@ SKIP_PREFLIGHT_CHECK=true
 API_GENCOMMENT=/** @generated THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. */
 
 REACT_APP_API_URL=https://api.github.com/graphql
-# TODO: Убрать позднее (пока что нужен для кодогенерации)
-REACT_APP_ACCESS_TOKEN=d70d97689ae25f0eb61a1f49ee49fa4b9fc3c370
+# Используется для кодогенерации, Apollo Client плагина
+REACT_APP_ACCESS_TOKEN=9221b1b5ba4b0de72eed80b09602ed7b4c73c222
+
+# Firebase section
+REACT_APP_FIREBASE_apiKey=AIzaSyABlBQc-tjCRKWwBj8jTTrMiT2M2UKiJpk
+REACT_APP_FIREBASE_authDomain=github-client-47c49.firebaseapp.com
+REACT_APP_FIREBASE_databaseURL=https://github-client-47c49.firebaseio.com
+REACT_APP_FIREBASE_projectId=github-client-47c49
+REACT_APP_FIREBASE_storageBucket=github-client-47c49.appspot.com
+REACT_APP_FIREBASE_messagingSenderId=14406286286
+REACT_APP_FIREBASE_appId=1:14406286286:web:58c7c11c2762d36a55c99f
+
+REACT_APP_DEV_STORAGE_URL=https://dev.github-client.gq/dev/temp-stands.html

.eslintrc.js

@@ -34,6 +34,7 @@ module.exports = {
                     "shared",
                     "shared/**",
                     "pages",
+                    "pages/**",
                     "features",
                     "features/**",
                     "models",

.github/workflows/dev-merge.yml

@@ -9,6 +9,7 @@ on:
 jobs:
   build_and_deploy:
     runs-on: ubuntu-latest
+    timeout-minutes: 12
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2

.github/workflows/dev-pr.yml

@@ -6,6 +6,7 @@ on: pull_request
 jobs:
   build_and_preview:
     runs-on: ubuntu-latest
+    timeout-minutes: 12
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2

.github/workflows/prod.yml

@@ -13,7 +13,7 @@ jobs:
   build:
 
     runs-on: ubuntu-latest
-
+    timeout-minutes: 12
     strategy:
       matrix:
         node-version: [12.x]

.stylelintrc

@@ -1,11 +1,16 @@
 {
+    "plugins": [
+        "stylelint-scss"
+    ],
     "extends": [
         "stylelint-config-standard",
         "stylelint-config-recommended",
         "stylelint-config-recess-order"
     ],
     "rules": {
         "indentation": 4,
-        "color-hex-length": "long"
+        "color-hex-length": "long",
+        "at-rule-no-unknown": null,
+        "scss/at-rule-no-unknown": true
     }
 }

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+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
+
+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
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+First of all, thanks for taking the time to contribute! :+1:
+
+## How Can I Contribute?
+[issues]: https://github.com/ani-team/github-client/issues
+[issues-new]: https://github.com/ani-team/github-client/issues/new
+[pr]: https://github.com/ani-team/github-client/pulls
+[pr-new]: https://github.com/ani-team/github-client/compare
+
+- [Report bugs, suggest improvements and new rules][issues-new]
+   > If something doesn't work well for you or can be done better, please let us know! 
+   When you are creating a new issue, fill out the issue template, the information it asks for helps us resolve issues faster.
+- Estimate [issues][issues] 
+   > Share your opinion, evaluate given problem context from author
+- Repeat difficult [issues][issues]
+   > Some issues hard to repeat
+- Review [pull requests][pr]
+   > Share your opinion and help us with others' suggestions!
+- Fix [typos, style, comments, docs, deps, ...][pr-new]
+   > And be tolerant of our CI...
+
+## Code Style
+1. Please, learn and follow our [accepted codestyle](https://github.com/ani-team/github-client/wiki/CodeStyle), [dev-guide](https://github.com/ani-team/github-client/wiki/Dev-Guide) and [project structure](https://github.com/ani-team/github-client/wiki/Project-Structure)
+2. We're using few code linters && formatters:
+    - ESLint (react + ts + graphql)
+    - Prettier
+    - Stylelint
+
+   Use [IDE plugins](https://github.com/ani-team/github-client/wiki/Dev-Guide#vscode) or [scripts with autofix before PR](https://github.com/ani-team/github-client/wiki/Dev-Guide#launch-tests)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ani-team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,64 +1,58 @@
 # github-client
-Github клиент в рамках курса *React Akvelon 2020*.
 
-<div style="display: flex;">
-<img title="github" alt="github" width="64" src="https://image.flaticon.com/icons/png/512/25/25231.png"/>
-<img title="react" alt="react" width="64" src="https://cdn.auth0.com/blog/react-js/react.png"/>
-<img title="antdesign" alt="antdesign" width="64" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg"/>
-<img title="graphql" alt="graphql" width="64" src="https://upload.wikimedia.org/wikipedia/commons/thumb/1/17/GraphQL_Logo.svg/1200px-GraphQL_Logo.svg.png"/>
-<img title="apollo" alt="apollo" width="64" src="https://miro.medium.com/max/300/0*xdVGlEH7f9cRVaR-"/>
-</div>
-
-## Ресурсы
-
-- [Структура проекта](STRUCTURE.md)
-- [Рекомендации по разработке](RECOMMENDATIONS.md)
-- [Project WIKI](https://github.com/martis-git/github-client/wiki)
-
-## Технический стек
-- **UI**: `react`, `antd`, `classnames`, `tailwindcss`
-- **Lang**: `typescript (3.7+)`
-- **Fetching**: `graphql`, `apollo-client (3+)`
-   - **API Codegen**: `graphql-codegen`
-- **Routing**: `react-router`
-- **Tests**: `eslint`, `prettier`, `graphql-eslint`, `stylelint`
-
-## Использование
+<img alt="favicon" src="https://avatars2.githubusercontent.com/oa/1406180?s=140&u=b44629cbec5079f99a61e6f1b6297bc4797f796b&v=4" height=120 align="right" />
 
-### Запуск локального dev-стенда
-```sh
-$ npm i                   # установка зависимостей
-$ npm run start           # запуск стенда
-```
+GitHub client within the *React Akvelon 2020* course.
 
-### Запуск тестов
-```sh
-$ npm run test            # запуск всех тестов
-```
+[wiki]: https://github.com/martis-git/github-client/wiki
+[requirements]: https://github.com/ani-team/github-client/wiki/%5BRU%5D-Requirements
+[codestyle]: https://github.com/ani-team/github-client/wiki/CodeStyle
+[structure]: https://github.com/ani-team/github-client/wiki/Project-Structure
+[dev-guide]: https://github.com/ani-team/github-client/wiki/Dev-Guide
 
-```sh
-$ npm run react:test      # unit тесты
-$ npm run lint:test       # тесты линтеров
-$ npm run lint:fix        # тесты линтеров с исправлением
-```
+- [Project WIKI][wiki]
+   - [Requirements (RU)][requirements]
+   - [Design](https://www.figma.com/file/HxOqIdmTNtLcFLcQZzAYJC/github-client "Super design from @AdeliyaG")
+   - [Dev Guide][dev-guide]
+   - [Structure][structure]
+   - [CodeStyle][codestyle]
+- [Contributing guide](CONTRIBUTING.md)
 
-### Работа с зависимостями
-```sh
-$ npm run deps:clean      # удаление лишних созданных файлов, node_modules
-$ npm run deps:reinstall  # переустановка зависимостей
-```
+## Overview
+<!-- Указаны ссылки на "prod"-стенд как на основной и более стабильный -->
 
-### Кодогенерация API
-```sh
-$ npm run api:gen         # сгенерировать типы и хуки для работы с API - одноразово
-$ npm run api:gen--watch  # сгенерировать типы и хуки для работы с API - watch-mode
-```
+- See repo/collabs list and details of [any user](https://github-client.gq/gaearon)
+- See base info of [any public repository](https://github-client.gq/facebook/react) with [branches base manipulating](https://github-client.gq/facebook/react/tree/17.0.0-dev)
+- Use search by [repositories](https://github-client.gq/search?o=desc&q=react&s=stars)/[users](https://github-client.gq/search?o=desc&q=google&s=repositories&type=users) with sorting
+- View corresponding page on github <b title="Our routing is identical with github">through origin button!</b>
+- Connect with your account safely - [by Github OAuth](https://github-client.gq/auth)
+- [Get feedback](https://github-client.gq/some-unexisting-route-but-we-have-error-parking-page) if some errors occurred
+- Try  [**github-client right now**](https://github-client.gq) or [last dev version (but unstable)](https://dev.github-client.gq) =}
 
-## VSCode
+> If you found issues or have ideas for service - please, [share with us](https://github.com/ani-team/github-client/issues/new) 🔥
 
-Список плагинов для лучшего DX:
-> Для всех - настроена базово необходимая конфигурация в проекте
+<img alt="screen" src="docs/search.png" />
 
-- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) - Автокомплит Tailwind классов в компонентах
-- [Apollo GraphQL](https://marketplace.visualstudio.com/items?itemName=apollographql.vscode-apollo) - IntelliSense с автокомплитом (но возможны подтормаживания)
-- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - Форматирование по сохранению, тестирование от линта
+## Technology stack
+- **UI**: `react`, `antd`, `classnames`, `tailwindcss`
+- **Lang**: `typescript (3.7+)`
+- **Fetching**: `graphql`, `apollo-client (3+)`
+   - **API Codegen**: `graphql-codegen`
+- **Routing**: `react-router`
+- <b title="Super linting from @martis-git">Tests</b>: `eslint`, `prettier`, `graphql-eslint`, `stylelint`
+- **Auth**: `GitHub OAuth`, `firebase`
+- <b title="Super CI/CD from @niyazm524">CI/CD</b>: `github-actions`, `firebase`
+
+<div align="center">
+<img title="react" alt="react" height=48 src="https://cdn.auth0.com/blog/react-js/react.png"/>
+<img title="typescript" alt="typescript" height=48 src="https://raw.githubusercontent.com/remojansen/logo.ts/master/ts.png"/>
+<img title="antdesign" alt="antdesign" height=48 src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg"/>
+<img title="graphql" alt="graphql" height=48 src="https://upload.wikimedia.org/wikipedia/commons/thumb/1/17/GraphQL_Logo.svg/1200px-GraphQL_Logo.svg.png"/>
+<img title="apollo" alt="apollo" height=48 src="https://miro.medium.com/max/300/0*xdVGlEH7f9cRVaR-"/>
+<img title="eslint" alt="eslint" height=48 src="https://d33wubrfki0l68.cloudfront.net/204482ca413433c80cd14fe369e2181dd97a2a40/092e2/assets/img/logo.svg"/>
+<img title="prettier" alt="prettier" height=48 src="https://prettier.io/icon.png"/>
+<img title="stylelint" alt="stylelint" height=48 src="https://camo.githubusercontent.com/aa04feafbd080140cd834905cf171ccf7b06fc5f1f1ae07ce9879218165312d1/68747470733a2f2f63646e2e776f726c64766563746f726c6f676f2e636f6d2f6c6f676f732f7374796c656c696e742e737667"/>
+<img title="github" alt="github" height=48 src="https://image.flaticon.com/icons/png/512/25/25231.png" />
+<img title="github-actions" alt="github-actions" height=48 src="https://avatars0.githubusercontent.com/u/44036562?s=200&v=4" />
+<img title="firebase" alt="firebase" height=48 src="https://www.gstatic.com/devrel-devsite/prod/v73fbca10ce7899da426d451b3f74ee09bc6846fcf427552c7e8e85261505ef2c/firebase/images/touchicon-180.png" />
+</div>