Update README.md

README.md

@@ -1,26 +1,41 @@
-# Train platform
+# About
 
-Проект по разработке веб-приложения для организации тренировочных курсов с элементами геймификации.
+Проект по разработке веб-приложения для организации тренировочных курсов с элементами геймификации
 
-Процесс командной разработки можно отследить на [канбан доске.](https://github.com/orgs/TeamHSE/projects/1/views/1)
+Технологии:
+- Frontend: React, Next.js, Bootstrap
+- Backend: Node.js, Express, ORM
+- DB: PostgreSQL
 
 # Quick start
 
-Запуск проекта:
-1. Run ```docker compose up -d```
-2. Application is available at:
-   - backend: [http://localhost:3000](http://localhost:3000/)
-   - frontend: [http://localhost:3001](http://localhost:3001/)
+## Информация о проекте
+Соглашения о процессе ведения проекта (роли, git, GitHub), а также документация доступны в [Wiki](https://github.com/TeamHSE/train-platform/wiki) проекта
 
+Вы также можете непосредственно отслеживать ход выполнения задач проекта в [Issues](https://github.com/TeamHSE/train-platform/issues), [Pull requests](https://github.com/TeamHSE/train-platform/pulls), а также на [Kanban-доске](https://github.com/orgs/TeamHSE/projects/1) проекта
 
-# About
+Что-то обсудить, предложить или задать вопрос можно в [разделе дискуссий](https://github.com/TeamHSE/train-platform/discussions/62). Будем рады пообщаться!
 
 - [API DOCS](https://github.com/TeamHSE/train-platform/wiki/Endpoints)
 - [Development Agreement](https://github.com/TeamHSE/train-platform/wiki/Dev-Experience)
 - [Buisness model](https://github.com/TeamHSE/train-platform/wiki/Business-model)
-- [UI](https://www.figma.com/file/K5YbaVEbehlOig6ZWo1Mft/HSE-Project?type=design&node-id=0%3A1&mode=design&t=ecU1TQEZhG9LRVbk-1)
+- [UI Design](https://www.figma.com/file/K5YbaVEbehlOig6ZWo1Mft/HSE-Project?type=design&node-id=0%3A1&mode=design&t=ecU1TQEZhG9LRVbk-1)
+
+## Запуск проекта
+
+### Docker (рекомендуется)
+Требования: Docker, docker-compose<br>
+
+Для запуска необходимо в корне проекта выполнить команду
+```
+docker-compose up --build
+```
+В Docker должны появиться 3 контейнера: для backend, frontend и postgres<br>
+Доступ к интерфейсу приложения по умолчанию осуществляется по адресу http://localhost:3001
+
+### Ручной запуск
 
-# Technical report
+Инструкции по ручному запуску приложения расположены в директориях backend (для запуска бэкенд-приложения) и frontend (для запуска фронтенд-приложения)
 
 - [Frontend](https://github.com/TeamHSE/train-platform/blob/develop/frontend/README.md)
-- [Backend](https://github.com/TeamHSE/train-platform/blob/develop/backend/README.md)
+- [Backend](https://github.com/TeamHSE/train-platform/blob/develop/backend/README.md)

frontend/README.md

@@ -1,36 +1,23 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Начало работы
 
-## Getting Started
+## Требования
+Проект использует Node.js 20 LTS, Next.JS 14, пакетный менеджер pnpm (также возможен npm)
 
-First, run the development server:
+Удостоверьтесь, что запускается среда разработки `development`
 
-```bash
+## Запуск:
+
+```
 npm run dev
-# or
+# или
 yarn dev
-# or
+# или
 pnpm dev
-# or
+# или
 bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
-
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
+Откройте http://localhost:3001 в вашем браузере, чтобы увидеть результат.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+По любым трудностям пишите в [Дискуссии](https://github.com/TeamHSE/train-platform/discussions/62) – будем рады оперативно помочь!
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.