Skip to content

Commit 7f7e4b1

Browse files
nemoipahanemoipaha
committed
Translate readme
1 parent e0c41d6 commit 7f7e4b1

File tree

2 files changed

+23
-31
lines changed

2 files changed

+23
-31
lines changed

‎backend/readme.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
* [CORS](https://developer.mozilla.org/ru/docs/Web/HTTP/CORS)
1212
* [JWT](https://ru.wikipedia.org/wiki/JSON_Web_Token) tokens
1313
* Websockets and [Pusher](https://pusher.com/) service
14+
* MySQL 5.7
1415

1516
## Install
1617

‎readme.md‎

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,22 @@
11
# BSA 2019 Thread
22

3-
[![Build Status](https://travis-ci.org/BinaryStudioAcademy/thread-php.svg?branch=dev)](https://travis-ci.org/BinaryStudioAcademy/thread-php)
4-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d1280e7b47b9492abd59cf0081a95cdb)](https://app.codacy.com/app/pavelnemoi/thread-php?utm_source=github.com&utm_medium=referral&utm_content=BinaryStudioAcademy/thread-php&utm_campaign=Badge_Grade_Settings)
5-
[![StyleCI](https://github.styleci.io/repos/178824653/shield)](https://styleci.io/repos/178824653)
6-
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
3+
## Описание
74

8-
## Description
5+
Этот мини-проект является [SPA](https://en.wikipedia.org/wiki/Single-page_application), который немного похож на Twitter :)
96

10-
This is a learning goal [SPA](https://en.wikipedia.org/wiki/Single-page_application) mini-project which is much like real Twitter, but even better of course :)
7+
Возможности:
118

12-
Core features:
9+
* Регистрация
10+
* Создание твита(или поста)
11+
* Комментрование твита
12+
* Обновление профиля пользователя
1313

14-
* Registration
15-
* Add tweets(or posts)
16-
* Add tweet's comments
17-
* Edit user's profile data
14+
*Основная идея этой стадии в том, чтобы получить понимание архитектуры приложения, организации и написания
15+
backend/frontend кода, использования дизайн паттернов и понимания алгоритма обработки данных.
16+
Нет необходимости в том, чтобы глубоко изучить каждую технологию, использованную в проекте, но важно получить
17+
общее понимание построения современного SPA веб-приложения и инструментов, которые могут в этом помочь.*
1818

19-
*Main idea for this stage is to get better understanding of application backend/frontend codebase,
20-
what design patterns was used and how to solve some widespread data processing tasks.
21-
There is no need to deeply learn all tech stack that was used to built this app,
22-
but just get an idea of modern SPA web application architecture and tools that can help to built it.*
23-
24-
## Technologies
19+
## Технологии
2520

2621
Backend:
2722

@@ -34,6 +29,7 @@ Backend:
3429
* [CORS](https://developer.mozilla.org/ru/docs/Web/HTTP/CORS)
3530
* [JWT](https://ru.wikipedia.org/wiki/JSON_Web_Token) tokens
3631
* Websockets and [Pusher](https://pusher.com/) service
32+
* MySQL 5.7
3733

3834
Frontend:
3935

@@ -44,18 +40,18 @@ Frontend:
4440
* [Buefy](https://buefy.org/) UI framework
4541
* [pusher-js](https://github.com/pusher/pusher-js)
4642

47-
Additional software which might be helpful
43+
## Дополнительные утилиты, которые могут быть полезны:
4844

4945
* [Postman](https://www.getpostman.com/) (debug your backend api endpoints)
5046
* [Vue devtools](https://github.com/vuejs/vue-devtools) (debug your frontend components state)
5147
* [MySQL Workbench](https://www.mysql.com/products/workbench/) (database management tool)
5248
* [PHPStorm](https://www.jetbrains.com/phpstorm/) || [VSCode](https://code.visualstudio.com/)
5349

54-
Github repository [https://github.com/BinaryStudioAcademy/thread-php](https://github.com/BinaryStudioAcademy/thread-php)
50+
Github репозиторий [https://github.com/BinaryStudioAcademy/thread-php](https://github.com/BinaryStudioAcademy/thread-php)
5551

56-
Application link [https://bsa-thread.now.sh](https://bsa-thread.now.sh).
52+
Адресс приложения [https://bsa-thread.now.sh](https://bsa-thread.now.sh).
5753

58-
Helpful articles or materials:
54+
## Вспомогательные материалы:
5955

6056
* [Dependency Injection](https://designpatternsphp.readthedocs.io/en/latest/Structural/DependencyInjection/README.html)
6157
* [Repository pattern](https://designpatternsphp.readthedocs.io/en/latest/More/Repository/README.html) (*Repository\UserRepository.php*)
@@ -65,9 +61,7 @@ Helpful articles or materials:
6561
* [Vue.js](https://www.youtube.com/playlist?list=PL5r0NkdgM0UOxb4Hl81FV5UIgexwTf8h7) tutorial
6662
* [Vuex](https://www.youtube.com/playlist?list=PL4cUxeGkcC9i371QO_Rtkl26MwtiJ30P2) tutorial
6763

68-
## Tasks:
69-
70-
Task list is prioritized, more relevant are on top.
64+
## Список задач, отсортирован по релевантности
7165

7266
1. [`/tweets/:id` page] As a user I can edit own comment text and attach an image file;
7367
2. [`/tweets/:id` page] As a user I can delete own commment;
@@ -79,17 +73,14 @@ Task list is prioritized, more relevant are on top.
7973
8. [`/feed` page] As a user I can filter tweets and see only my favourite(was liked by me);
8074
9. [`/tweets/:id` page] As a user I can paginate comments list using infinite scroll;
8175
10. [`/tweets/:id` page] As a user I can see modal window which shows all users who liked a comment by click on likes count;
82-
11. As a user I should be able to forgot and reset my password using an email;
76+
11. As a user I should be able to reset my password using an email (forgot password feature);
8377
12. [`/feed` page] As a user I want to see tweet's likes or comments count icon highlighted by some color if I liked or commented this tweet;
8478
13. [`/tweets/:id` page] As a user I want see newly added comments in realtime similar to tweets;
8579
14. [`/feed` page] As a user I want to switch between tweets layout view([cards](https://bulma.io/documentation/components/card/) or [media](https://bulma.io/documentation/layout/media-object/) objects);
8680

87-
You can use [Trello](https://trello.com) board to manage your tasks. Create lists like: Backlog, In Progress, Done. Put all tickets into Backlog first and move them into appropriate list depends on their status.
88-
89-
## Install
81+
Для удобства вам предлагается создать [Trello](https://trello.com) доску для организации процесса выполнения задач. Создайте списки: Backlog, In Progress, Done. Создайте задачи в Backlog списке и перемещайте их в соответствующий список(In Progress, Done) в зависимости от их статуса.
9082

91-
Installation is described inside backend and frontend folders independently.
83+
## Послесловие
9284

93-
## License
85+
Основная идея выполнения задач к этому проекту заключается в том, чтобы получить небольшой опыт в решении практических задач и расширении функционала, набить шишки, копаясь в чужом коде, и ознакомиться с архитектурой приложения в целом, а также научиться писать свой "production ready" кодешник :) Это задание не будет оцениваться предметно, используя систему баллов, как в предыдущих домашних заданиях, оцениваться будет ваше старание и мотивация разобраться.
9486

95-
[MIT license](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)