generated from yandex-praktikum/middle.messenger.praktikum.yandex
-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sprint 1 #2
Merged
Merged
Sprint 1 #2
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7659b96
feat: added ui pics
ilyakaverin 1b98bbf
feat: added templates, routes
ilyakaverin caa56c5
fix: fixed README, fixed eslint issues
ilyakaverin 8ec12d0
fix: changed port
ilyakaverin 35caf92
Rename 5**.pug to 500.pug
ilyakaverin d9e242c
fix: some reviewer issues
ilyakaverin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,3 @@ | ||
node_modules | ||
.parcel-cache | ||
dist |
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,16 @@ | ||
{ | ||
"env": { | ||
"browser": true, | ||
"es2021": true | ||
}, | ||
"extends": "airbnb-base", | ||
"overrides": [ | ||
], | ||
"parserOptions": { | ||
"ecmaVersion": "latest", | ||
"sourceType": "module" | ||
}, | ||
"rules": { | ||
"no-underscore-dangle": [2, { "allow": ["__filename", "__dirname"] }] | ||
} | ||
} |
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 @@ | ||
node_modules | ||
dist | ||
.parcel-cache |
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,7 @@ | ||
{ | ||
"extends": "@parcel/config-default", | ||
"transformers": { | ||
"*.hbs": ["@anikin/parcel-transformer-handlebars"] | ||
} | ||
|
||
} |
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,10 @@ | ||
### Ветка, в которой делаете задания спринта, должна называться sprint_i, где i - номер спринта. Не переименовывайте её. | ||
|
||
### Откройте pull request в ветку main из ветки, где вы разрабатывали проект, и добавьте ссылку на этот pr в README.md в ветке main. | ||
### ВАЖНО: pull request должен называться “Sprint i” (i — номер спринта). | ||
|
||
### Например, задания для проектной работы во втором спринте вы делаете в ветке sprint_2. Открываете из неё pull request в ветку main. Ссылку на этот pr добавляете в README.md в ветке main. После этого на платформе Практикума нажимаете «Проверить задание». | ||
|
||
### Также не забудьте проверить, что репозиторий публичный. | ||
--- | ||
|
||
|
||
Даже законченный проект остаётся только заготовкой, пока им не начнут пользоваться. Но сначала пользователь должен понять, зачем ему пользоваться вашим кодом. В этом помогает файл README. | ||
|
||
README — первое, что прочитает пользователь, когда попадёт в репозиторий на «Гитхабе». Хороший REAMDE отвечает на четыре вопроса: | ||
|
||
- Готов ли проект к использованию? | ||
- В чём его польза? | ||
- Как установить? | ||
- Как применять? | ||
|
||
## Бейджи | ||
|
||
Быстро понять статус проекта помогают бейджи на «Гитхабе». Иногда разработчики ограничиваются парой бейджев, которые сообщат о статусе тестов кода: | ||
|
||
![Бэйджи](https://github.com/yandex-praktikum/mf.messenger.praktikum.yandex.images/blob/master/mf/b.png) | ||
|
||
Если пользователь увидит ошибку в работе тестов, то поймёт: использовать текущую версию в важном проекте — не лучшая идея. | ||
|
||
Бейджи помогают похвастаться достижениями: насколько популярен проект, как много разработчиков создавало этот код. Через бейджи можно даже пригласить пользователя в чат: | ||
|
||
![Версии](https://github.com/yandex-praktikum/mf.messenger.praktikum.yandex.images/blob/master/mf/vers.png) | ||
|
||
В README **Webpack** строка бейджев подробно рассказывает о покрытии кода тестами. Когда проект протестирован, это вызывает доверие пользователя. Последний бейдж приглашает присоединиться к разработке. | ||
|
||
Другая строка убедит пользователя в стабильности инфраструктуры и популярности проекта. Последний бейдж зовёт в чат проекта. | ||
|
||
## Описание | ||
|
||
Краткое опишите, какую задачу решает проект. Пользователь не верит обещаниям и не готов читать «полотна» текста. Поэтому в описании достаточно нескольких строк: | ||
|
||
![Описание](https://github.com/yandex-praktikum/mf.messenger.praktikum.yandex.images/blob/master/mf/desc.png) | ||
|
||
Авторы **React** дробят описание на абзацы и списки — так проще пробежаться глазами по тексту и найти ключевую информацию. | ||
|
||
Если у проекта есть сайт, добавьте ссылку в заголовок. | ||
|
||
## Установка | ||
|
||
Лучше всего пользователя убеждает собственный опыт. Чем быстрее он начнёт пользоваться проектом, тем раньше почувствует пользу. Для этого помогите ему установить приложение: напишите краткую пошаговую инструкцию. | ||
|
||
Если проект предназначен для разработчиков, добавьте информацию об установке тестовых версий. Например: | ||
|
||
- `npm install` — установка стабильной версии, | ||
- `npm i` — установка стабильной версии, | ||
- `npm start` — запуск версии для разработчика, | ||
- `npm run build:prod` — сборка стабильной версии. | ||
|
||
## **Примеры использования** | ||
|
||
Хорошо, если сразу после установки пользователь сможет решить свои задачи без изучения проекта. Это особенно верно, если ваш пользователь — не профессиональный разработчик. Но даже профессионал поймёт вас лучше, если показать примеры использования: | ||
|
||
![Ссылки](https://github.com/yandex-praktikum/mf.messenger.praktikum.yandex.images/blob/master/mf/link.png) | ||
|
||
Для более подробных инструкции добавьте новые разделы или ссылки: | ||
|
||
- на документацию, | ||
- вики проекта, | ||
- описание API. | ||
|
||
В учебном проекте будут полезен раздел с описанием стиля кода и правилами разработки: как работать с ветками, пул-реквестами и релизами. | ||
|
||
### **Команда** | ||
|
||
Если вы работаете в команде, укажите основных участников: им будет приятно, а новые разработчики охотнее присоединятся к проекту. «Гитхаб» — не просто инструмент, это социальная сеть разработчиков. | ||
- `npm run build` — сборка стабильной версии. | ||
|
||
![Команда](https://github.com/yandex-praktikum/mf.messenger.praktikum.yandex.images/blob/master/mf/team.png) | ||
Чат в ретро стиле с олдскульными шрифтами картинками, основная идея совместить современные технологии со старыми приемами в веб дизайне | ||
|
||
### **Примеры README** | ||
|
||
- «[Реакт](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/)». | ||
[netlify link](https://ilyakaverinchat.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,9 @@ | ||
# Global settings applied to the whole site. | ||
# | ||
# “base” is the directory to change to before starting build. If you set base: | ||
# that is where we will look for package.json/.nvmrc/etc, not repo root! | ||
# “command” is your build command. | ||
# “publish” is the directory to publish (relative to the root of your repo). | ||
|
||
[build] | ||
publish = "dist" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Нужно исправить