Skip to content
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 #34

Open
wants to merge 33 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
500b658
add project
LevanovaElena Sep 5, 2023
e830d89
add express
LevanovaElena Sep 5, 2023
9259828
fixed errors
LevanovaElena Sep 5, 2023
b2916dc
readmy.md
LevanovaElena Sep 5, 2023
2be6b18
netlify
LevanovaElena Sep 5, 2023
c7d319c
netlify
LevanovaElena Sep 5, 2023
bf7400f
fixed error
LevanovaElena Sep 5, 2023
c92e0b5
fixed error
LevanovaElena Sep 5, 2023
11b08db
fixed error
LevanovaElena Sep 5, 2023
23fa533
fixed error
LevanovaElena Sep 5, 2023
e8f05e9
fixed error
LevanovaElena Sep 5, 2023
43df296
fixed error
LevanovaElena Sep 5, 2023
7a0a48c
fixed error
LevanovaElena Sep 5, 2023
0fe67ec
fixed error
LevanovaElena Sep 5, 2023
89159a5
fixed error
LevanovaElena Sep 5, 2023
5a3cc8f
fixed error
LevanovaElena Sep 5, 2023
8cc2a98
fixed error
LevanovaElena Sep 5, 2023
fa88151
added lf
LevanovaElena Sep 5, 2023
90e9320
added lf
LevanovaElena Sep 5, 2023
6abd1b5
added cr
LevanovaElena Sep 5, 2023
9009af2
added lf
LevanovaElena Sep 5, 2023
fe1e148
added lf
LevanovaElena Sep 5, 2023
7b58357
added lf
LevanovaElena Sep 5, 2023
26efede
added new lines
LevanovaElena Sep 5, 2023
428784e
added new lines
LevanovaElena Sep 5, 2023
9fd97bd
added new lines
LevanovaElena Sep 5, 2023
61bb68e
added new lines
LevanovaElena Sep 5, 2023
34baa61
added new lines
LevanovaElena Sep 5, 2023
01ddaf6
added new lines
LevanovaElena Sep 5, 2023
901d0f9
fixed engines
LevanovaElena Sep 5, 2023
97b5cd6
merge from sprint_1
LevanovaElena Sep 5, 2023
4369c1a
fixed errors
LevanovaElena Sep 5, 2023
0d2dbac
fixed errors by review
LevanovaElena Sep 6, 2023
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
24 changes: 24 additions & 0 deletions .gitignore
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?
5 changes: 5 additions & 0 deletions .postcssrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"plugins": {
"postcss-preset-env": {}
}
}
94 changes: 20 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,83 +1,29 @@
### Ветка, в которой делаете задания спринта, должна называться sprint_i, где i - номер спринта. Не переименовывайте её.
# Messenger
___
### Project 1 for course Middle Yandex.

### Откройте pull request в ветку main из ветки, где вы разрабатывали проект, и добавьте ссылку на этот pr в README.md в ветке main.
### ВАЖНО: pull request должен называться “Sprint i” (i — номер спринта).
### Design
___

### Например, задания для проектной работы во втором спринте вы делаете в ветке sprint_2. Открываете из неё pull request в ветку main. Ссылку на этот pr добавляете в README.md в ветке main. После этого на платформе Практикума нажимаете «Проверить задание».
[Link on Figma](https://www.figma.com/file/FfgnMjuShWBBLmFMls5Ryy/Chat_my_design?type=design&node-id=0-1&mode=design&t=14mgPG10l7FRQJOL-0 "Link on Figma")

### Также не забудьте проверить, что репозиторий публичный.
---

### Tech stack:
___

Даже законченный проект остаётся только заготовкой, пока им не начнут пользоваться. Но сначала пользователь должен понять, зачем ему пользоваться вашим кодом. В этом помогает файл README.
- Vite 4.4.9
- Node.js >14.0.0
- Handlebars (vite-plugin-handlebars)
- Typescript 5.2.2
- Postcss(plugin postcss-preset-env)

README — первое, что прочитает пользователь, когда попадёт в репозиторий на «Гитхабе». Хороший REAMDE отвечает на четыре вопроса:
### How to use
___

- Готов ли проект к использованию?
- В чём его польза?
- Как установить?
- Как применять?
use ```npm run dev``` - for start development <br>
use ```npm run start``` - for build and start server

## Бейджи
### Demo
___
[Site on Netlify](https://messenger-yandex-el.netlify.app/)

Быстро понять статус проекта помогают бейджи на «Гитхабе». Иногда разработчики ограничиваются парой бейджев, которые сообщат о статусе тестов кода:

![Бэйджи](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 start` — запуск версии для разработчика,
- `npm run build:prod` — сборка стабильной версии.

## **Примеры использования**

Хорошо, если сразу после установки пользователь сможет решить свои задачи без изучения проекта. Это особенно верно, если ваш пользователь — не профессиональный разработчик. Но даже профессионал поймёт вас лучше, если показать примеры использования:

![Ссылки](https://github.com/yandex-praktikum/mf.messenger.praktikum.yandex.images/blob/master/mf/link.png)

Для более подробных инструкции добавьте новые разделы или ссылки:

- на документацию,
- вики проекта,
- описание API.

В учебном проекте будут полезен раздел с описанием стиля кода и правилами разработки: как работать с ветками, пул-реквестами и релизами.

### **Команда**

Если вы работаете в команде, укажите основных участников: им будет приятно, а новые разработчики охотнее присоединятся к проекту. «Гитхаб» — не просто инструмент, это социальная сеть разработчиков.

![Команда](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/)».
10 changes: 10 additions & 0 deletions netlify.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# 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"

Loading