Skip to content
This repository has been archived by the owner on Aug 30, 2024. It is now read-only.

Vite template #33

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
@@ -1,12 +0,0 @@
root = true

[*]
Expand All @@ -9,4 +10,4 @@ insert_final_newline = true
charset = utf-8

[*.md]
trim_trailing_whitespace = false
trim_trailing_whitespace = false
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VITE_REACT_APP_EXAMPLE=env_example
20 changes: 20 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
extends: [
'eslint:recommended',
'plugin:react/recommended',
'plugin:react/jsx-runtime',
'plugin:react-hooks/recommended',
],
ignorePatterns: ['dist', '.eslintrc.cjs'],
parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
settings: { react: { version: '18.2' } },
plugins: ['react-refresh'],
rules: {
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
},
}
6 changes: 3 additions & 3 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v2.3.1
uses: actions/checkout@v3

- name: Install, lint, build 🔧
run: |
npm install
npm run lint:js
npm run lint
npm run build

- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: build
folder: dist
46 changes: 21 additions & 25 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,28 +1,24 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

#Junk
.DS_Store
.vscode/
.idea/

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
80 changes: 62 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@

# React homework template

Этот проект был создан при помощи
[Create React App](https://github.com/facebook/create-react-app). Для знакомства
и настройки дополнительных возможностей
[обратись к документации](https://facebook.github.io/create-react-app/docs/getting-started).
Этот проект был создан при помощи [Vite](https://vitejs.dev). Для знакомства и
настройки дополнительных возможностей
[обратись к документации](https://vitejs.dev/guide/).

## Подготовка нового проекта

Expand All @@ -17,10 +16,10 @@
5. Открой проект в VSCode, запусти терминал и свяжи проект с GitHub-репозиторием
[по инструкции](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories#changing-a-remote-repositorys-url).
6. Установи базовые зависимости проекта командой `npm install`.
7. Запусти режим разработки, выполнив команду `npm start`.
8. Перейди в браузере по адресу [http://localhost:3000](http://localhost:3000).
Эта страница будет автоматически перезагружаться после сохранения изменений в
файлах проекта.
7. Запусти режим разработки, выполнив команду `npm start dev`.
8. Перейди в браузере по адресу [http://localhost:5173](http://localhost:5173)
или [http://127.0.0.1:5173](http://127.0.0.1:5173). Эта страница будет
автоматически перезагружаться после сохранения изменений в файлах проекта.

## Деплой

Expand All @@ -34,11 +33,20 @@
"homepage": "https://your_username.github.io/your_repo_name/"
```

Добавить запись в файле vite.config.json строку `base: '/your_repo_name/'`,

```js
export default defineConfig({
plugins: [react()],
base: '/your_repo_name/',
});
```

Далее необходимо зайти в настройки GitHub-репозитория (`Settings` > `Pages`) и
выставить раздачу продакшн версии файлов из папки `/root` ветки `gh-pages`, если
это небыло сделано автоматически.

![GitHub Pages settings](./assets/repo-settings.png)
![GitHub Pages settings](src/assets/readme-images/repo-settings.png)

### Статус деплоя

Expand All @@ -51,7 +59,7 @@
Более детальную информацию о статусе можно посмотреть кликнув по иконке, и в
выпадающем окне перейти по ссылке `Details`.

![Deployment status](./assets/status.png)
![Deployment status](src/assets/readme-images//status.png)

### Живая страница

Expand All @@ -66,20 +74,35 @@

### Маршрутизация

Если приложение использует библиотеку `react-router-dom` для маршрутизации,
необходимо дополнительно настроить компонент `<BrowserRouter>`, передав в пропе
`basename` точное название твоего репозитория. Слеши в начале и конце строки
обязательны.
Если приложение использует библиотеку `react-router-dom-v6` для маршрутизации,
необходимо дополнительно настроить компонент `<RouterProvider>`, передав в пропе
`router` объект соответствующий объект, созданный при помощи `createHashRouter`,
т.к. GitHub не потдерживает `BrowserRouter`.

```jsx
<BrowserRouter basename="/your_repo_name/">
<App />
</BrowserRouter>
import { createHashRouter, RouterProvider } from 'react-router-dom';

const router = createHashRouter([
{
path: '/',
element: <App />,
},
{
path: '/other-path',
element: <OtherComponent />,
},
]);

ReactDOM.createRoot(document.getElementById('root')).render(
<React.StrictMode>
<RouterProvider router={router} />
</React.StrictMode>
);
```

## Как это работает

![How it works](./assets/how-it-works.png)
![How it works](src/assets/readme-images//how-it-works.png)

1. После каждого пуша в ветку `main` GitHub-репозитория, запускается специальный
скрипт (GitHub Action) из файла `.github/workflows/deploy.yml`.
Expand All @@ -88,3 +111,24 @@
3. Если все шаги прошли успешно, собранная продакшн версия файлов проекта
отправляется в ветку `gh-pages`. В противном случае, в логе выполнения
скрипта будет указано в чем проблема.

## ENV Переменные

В файле `.env` создаем переменную с префиксом `VITE_REACT_APP_variable_name`
после чего, в компоненте можно получить это значение при помощи
`import.meta.env.variable_name`.

Пример:

```shell
.env file

VITE_REACT_APP_EXAMPLE=env_example

```

```jsx
component file

import.meta.env.VITE_REACT_APP_EXAMPLE;
```
16 changes: 16 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!doctype html>
<html lang="en">

<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>GoIT | Vite + React homework template</title>
</head>

<body>
<div id="root"></div>
<script type="module" src="/src/main.jsx"></script>
</body>

</html>
6 changes: 4 additions & 2 deletions jsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@
"compilerOptions": {
"baseUrl": "src"
},
"include": ["src"]
}
"include": [
"src"
]
}
Loading