-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from JeffChen-png/sprint_1
Sprint 1
- Loading branch information
Showing
93 changed files
with
2,909 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# 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? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
registry=https://registry.npmjs.org/ | ||
strict-ssl=false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
20.8.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"printWidth": 120, | ||
"endOfLine": "lf", | ||
"singleQuote": true, | ||
"tabWidth": 2, | ||
"indentStyle": "space", | ||
"useTabs": false, | ||
"trailingComma": "es5", | ||
"bracketSpacing": true, | ||
"arrowParens": "avoid" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,83 +1,22 @@ | ||
### Ветка, в которой делаете задания спринта, должна называться sprint_i, где i - номер спринта. Не переименовывайте её. | ||
# О проекте | ||
|
||
### Откройте pull request в ветку main из ветки, где вы разрабатывали проект, и добавьте ссылку на этот pr в README.md в ветке main. | ||
### ВАЖНО: pull request должен называться “Sprint i” (i — номер спринта). | ||
Привет, это мой первый учебный проект на Яндекс.практикум | ||
Суть проекта - мессенджер. Мессенджер, в котором пользователи смогут переписываться друг с другом, отправлять картинки и общаться в группах | ||
|
||
### Например, задания для проектной работы во втором спринте вы делаете в ветке sprint_2. Открываете из неё pull request в ветку main. Ссылку на этот pr добавляете в README.md в ветке main. После этого на платформе Практикума нажимаете «Проверить задание». | ||
# О технологиях | ||
|
||
### Также не забудьте проверить, что репозиторий публичный. | ||
--- | ||
- Vite (для сборки) | ||
- SCSS (для стилизации) | ||
- Handlebars (для шаблонизации) | ||
- Netlify (для деплоя) | ||
- TS (для души и тела) | ||
|
||
|
||
Даже законченный проект остаётся только заготовкой, пока им не начнут пользоваться. Но сначала пользователь должен понять, зачем ему пользоваться вашим кодом. В этом помогает файл README. | ||
|
||
README — первое, что прочитает пользователь, когда попадёт в репозиторий на «Гитхабе». Хороший REAMDE отвечает на четыре вопроса: | ||
|
||
- Готов ли проект к использованию? | ||
- В чём его польза? | ||
- Как установить? | ||
- Как применять? | ||
|
||
## Бейджи | ||
|
||
Быстро понять статус проекта помогают бейджи на «Гитхабе». Иногда разработчики ограничиваются парой бейджев, которые сообщат о статусе тестов кода: | ||
|
||
 | ||
|
||
Если пользователь увидит ошибку в работе тестов, то поймёт: использовать текущую версию в важном проекте — не лучшая идея. | ||
|
||
Бейджи помогают похвастаться достижениями: насколько популярен проект, как много разработчиков создавало этот код. Через бейджи можно даже пригласить пользователя в чат: | ||
|
||
 | ||
|
||
В README **Webpack** строка бейджев подробно рассказывает о покрытии кода тестами. Когда проект протестирован, это вызывает доверие пользователя. Последний бейдж приглашает присоединиться к разработке. | ||
|
||
Другая строка убедит пользователя в стабильности инфраструктуры и популярности проекта. Последний бейдж зовёт в чат проекта. | ||
|
||
## Описание | ||
|
||
Краткое опишите, какую задачу решает проект. Пользователь не верит обещаниям и не готов читать «полотна» текста. Поэтому в описании достаточно нескольких строк: | ||
|
||
 | ||
|
||
Авторы **React** дробят описание на абзацы и списки — так проще пробежаться глазами по тексту и найти ключевую информацию. | ||
|
||
Если у проекта есть сайт, добавьте ссылку в заголовок. | ||
|
||
## Установка | ||
|
||
Лучше всего пользователя убеждает собственный опыт. Чем быстрее он начнёт пользоваться проектом, тем раньше почувствует пользу. Для этого помогите ему установить приложение: напишите краткую пошаговую инструкцию. | ||
|
||
Если проект предназначен для разработчиков, добавьте информацию об установке тестовых версий. Например: | ||
# Установка и использование | ||
|
||
- `npm install` — установка стабильной версии, | ||
- `npm start` — запуск версии для разработчика, | ||
- `npm run build:prod` — сборка стабильной версии. | ||
|
||
## **Примеры использования** | ||
|
||
Хорошо, если сразу после установки пользователь сможет решить свои задачи без изучения проекта. Это особенно верно, если ваш пользователь — не профессиональный разработчик. Но даже профессионал поймёт вас лучше, если показать примеры использования: | ||
|
||
 | ||
|
||
Для более подробных инструкции добавьте новые разделы или ссылки: | ||
|
||
- на документацию, | ||
- вики проекта, | ||
- описание API. | ||
|
||
В учебном проекте будут полезен раздел с описанием стиля кода и правилами разработки: как работать с ветками, пул-реквестами и релизами. | ||
|
||
### **Команда** | ||
|
||
Если вы работаете в команде, укажите основных участников: им будет приятно, а новые разработчики охотнее присоединятся к проекту. «Гитхаб» — не просто инструмент, это социальная сеть разработчиков. | ||
|
||
 | ||
- `npm run start` — cборка проекта, | ||
- `npm run dev` — запуск в режиме разработки. | ||
|
||
### **Примеры README** | ||
### [макет (незакончен)](<https://www.figma.com/file/rxBLi5OAmiuqKN46hu1tDY/Chat_external_link-(Copy)?node-id=48685%3A851&mode=dev>) | ||
|
||
- «[Реакт](https://github.com/facebook/react)», | ||
- «[Эхо](https://github.com/labstack/echo)», | ||
- «[Вебпак](https://github.com/webpack/webpack)», | ||
- «[ТДенгине](https://github.com/taosdata/TDengine)», | ||
- «[Соул-хантинг](https://github.com/vladpereskokov/soul-hunting/)». | ||
### [ссылка](https://tiny-stroopwafel-9abb82.netlify.app/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!DOCTYPE html> | ||
<html lang="ru"> | ||
<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" /> | ||
<link rel="stylesheet" href="./src/style.scss" /> | ||
<link rel="preconnect" href="https://fonts.googleapis.com" /> | ||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin /> | ||
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;500;700&display=swap" rel="stylesheet" /> | ||
<title>Vite + TS</title> | ||
</head> | ||
<body> | ||
<main> | ||
<div id="app"></div> | ||
</main> | ||
<script type="module" src="/src/main.ts"></script> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[build] | ||
publish = "dist" | ||
command = "npm run build" |
Oops, something went wrong.