Dev

.github/workflows/deploy.yml

@@ -0,0 +1,21 @@
+name: Deploy to pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./build

.gitignore

@@ -8,10 +8,11 @@ pnpm-debug.log*
 lerna-debug.log*
 
 node_modules
-dist
 dist-ssr
 *.local
 
+.env
+
 # Editor directories and files
 .vscode/*
 !.vscode/extensions.json

README.md

@@ -1,54 +1,80 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config({
-  extends: [
-    // Remove ...tseslint.configs.recommended and replace with this
-    ...tseslint.configs.recommendedTypeChecked,
-    // Alternatively, use this for stricter rules
-    ...tseslint.configs.strictTypeChecked,
-    // Optionally, add this for stylistic rules
-    ...tseslint.configs.stylisticTypeChecked,
-  ],
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
+![Иллюстрация к проекту](for_readme/preview.png)
+
+![react version](https://img.shields.io/badge/react-19.0.0-brightgreen)
+![react-router-dom version](https://img.shields.io/badge/react--router--dom-7.5.0-brightgreen)
+![sass version](https://img.shields.io/badge/sass-1.86.0-brightgreen)
+![mobx version](https://img.shields.io/badge/mobx-6.13.7-brightgreen)
+![eslint version](https://img.shields.io/badge/eslint-9.21.0-brightgreen)
+![webpack version](https://img.shields.io/badge/webpack-5.99.8-brightgreen)
+
+Потыкать можно -> ✨[здесь](https://vellun.github.io/github-client)✨ <-
+
+- [Что реализовано](#что-реализовано)
+  - [1. Поиск и фильтрация](#1-поиск-и-фильтрация)
+  - [2. История просмотров](#2-история-просмотров)
+  - [3. Аутентификация](#3-аутентификация)
+  - [4. Страница профиля](#4-страница-профиля)
+  - [5. Адаптив и тёмная тема](#5-адаптив-и-тёмная-тема)
+- [Локальный запуск](#запуск-проекта)
+  - [1. Клонировать проект](#1-клонировать-проект)
+  - [2. Перейти в директорию проекта](#2-перейти-в-директорию-проекта)
+  - [3. Установить зависимости](#3-установить-зависимости)
+  - [4. Запустить](#4-запустить)
+
+![Иллюстрация к проекту](for_readme/screen.png)
+
+## Что реализовано
+
+### 1. Поиск и фильтрация:
+
+- Поиск репозиториев и пользователей
+- Фильтрация результатов по различным параметрам
+
+### 2. История просмотров:
+
+- Сохранение и отображение последних просмотренных репозиториев; реализовано через LocalStorage
+
+### 3. Аутентификация
+
+- Аутентификация через GitHub; реализовано через Firebase
+
+### 4. Страница профиля:
+
+- Отображение информации о пользователе и его репозиториях
+- Возможность поиска и фильтрации по репозиториям пользователя
+
+### 5. Адаптив и тёмная тема
+
+![Иллюстрация к проекту](for_readme/phone-screen.png)
+
+## Локальный запуск
+
+### 1. Клонировать проект
+
+```bash
+git clone https://github.com/vellun/github-client
+```
+
+### 2. Перейти в директорию проекта
+
+```bash
+cd github-client
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default tseslint.config({
-  plugins: {
-    // Add the react-x and react-dom plugins
-    'react-x': reactX,
-    'react-dom': reactDom,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended typescript rules
-    ...reactX.configs['recommended-typescript'].rules,
-    ...reactDom.configs.recommended.rules,
-  },
-})
+### 3. Установить зависимости
+
+```bash
+yarn install
+```
+
+### 4. Запустить
+
+```bash
+yarn start
+```
+
+По умолчанию приложение будет доступно на порту 3000
+
+```bash
+http://localhost:3000
 ```

babel.config.json

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-typescript",
+    [
+      "@babel/preset-react",
+      {
+        "runtime": "automatic"
+      }
+    ]
+  ]
+}