Обновить rEAdme.md
This commit is contained in:
parent
56cb4fc37e
commit
7ccd4ab498
139
rEAdme.md
139
rEAdme.md
@ -1,130 +1,15 @@
|
|||||||
<a id="readme-top"></a>
|
# ESC - English Speaking Club
|
||||||
|
### MVP
|
||||||
|
|
||||||
<!-- PROJECT LOGO -->
|
- Main page (by Svetlana Kostrova)
|
||||||
<br />
|
|
||||||
<div align="center">
|
|
||||||
<h3 align="center">Car Dry Wash Service App</h3>
|
|
||||||
|
|
||||||
<p align="center">
|
- leave contact form - для записи на встречу достаточно оставить имя и номер телефона. Данные отправятся в тг бота, а хост обзвонит всех для подтверждения брони.
|
||||||
This project is designed to provide a user-friendly platform for scheduling and managing dry car wash services
|
|
||||||
<br />
|
|
||||||
<a href=""><strong>Explore the docs »</strong></a>
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- TABLE OF CONTENTS -->
|
- Price list (by Dmitry Ryabov) - спиоск всевозможных функций участия во встречах English Speaking Club'a. Разовое посещение или абонемент на 10 встреч? Осталось только выбрать подходящую опцию!
|
||||||
<details>
|
- Educational materials page (by Dmitry Ryabov) - видео, подкасты и прочая образовательная информация, которая будет полезна участникам.
|
||||||
<summary>Table of Contents</summary>
|
- B2B page (by Svetlana Kostrova) - торговое предложение для владельцев бизнеса! Если хотите, чтобы спикинг клаб проходил у вас - изучите информацию на этой странице.
|
||||||
<ol>
|
- Interactive (by David Larukov & Murad Bakiev)
|
||||||
<li>
|
|
||||||
<a href="#about-the-project">About The Project</a>
|
- Listening - понимание английской речи на слух, а также ответы на вопросы касающиеся ключевых моментов в беседе
|
||||||
<ul>
|
- Pronunciation - игра на выбор правильной транскрипции
|
||||||
<li><a href="#built-with">Built With</a></li>
|
- Test - позволяет определить уровень английского по шкале от A1 до C1
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<a href="#getting-started">Getting Started</a>
|
|
||||||
<ul>
|
|
||||||
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
||||||
<li><a href="#installation">Installation</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li><a href="#usage">Usage</a></li>
|
|
||||||
<li><a href="#roadmap">Roadmap</a></li>
|
|
||||||
<li><a href="#contributing">Contributing</a></li>
|
|
||||||
<li><a href="#license">License</a></li>
|
|
||||||
<li><a href="#contact">Contact</a></li>
|
|
||||||
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
|
||||||
</ol>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<!-- ABOUT THE PROJECT -->
|
|
||||||
|
|
||||||
## About The Project
|
|
||||||
|
|
||||||
### MVP1
|
|
||||||
|
|
||||||
**1. Landing**
|
|
||||||
|
|
||||||
- преимущества сервиса
|
|
||||||
- оставить заявку (редирект на Страницу оформления заказа)
|
|
||||||
|
|
||||||
**2. Страница для оформления заказа**
|
|
||||||
|
|
||||||
- форма
|
|
||||||
- номер машины (mask input)
|
|
||||||
- цвет машины
|
|
||||||
- geo-точка (?)
|
|
||||||
- тайм-слот нахождения машины по geo-точке
|
|
||||||
- тип кузова (радио с иконками)
|
|
||||||
- после заполнения редирект на страницу с деталями заказа
|
|
||||||
|
|
||||||
**3. Страница с деталями заказа**
|
|
||||||
|
|
||||||
- описание заказа
|
|
||||||
- детали заказа (id, статус)
|
|
||||||
|
|
||||||
**3. АРМ оператора**
|
|
||||||
|
|
||||||
- список заказов (RUD)
|
|
||||||
- id заказа
|
|
||||||
- статус заказа (готово / не готово)
|
|
||||||
- кнопка "Удалить заказ"
|
|
||||||
- список мойщиков (CRD)
|
|
||||||
- id мойщика
|
|
||||||
- данные (ФИО, телефон)
|
|
||||||
- кнопка "Добавить"
|
|
||||||
- кнопка "Удалить"
|
|
||||||
|
|
||||||
### Built With
|
|
||||||
|
|
||||||
[![React][React.js]][React-url]
|
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
||||||
|
|
||||||
<!-- GETTING STARTED -->
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
|
|
||||||
- npm
|
|
||||||
```sh
|
|
||||||
npm install npm@latest -g
|
|
||||||
```
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
1. Clone the repo
|
|
||||||
```sh
|
|
||||||
git clone https://git.bro-js.ru/dry_wash_inc/dry-wash-pl.git
|
|
||||||
```
|
|
||||||
2. Install NPM packages
|
|
||||||
```sh
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
||||||
|
|
||||||
## Instructions
|
|
||||||
### Stubs types generation
|
|
||||||
1. generate types with json-literal-typer (should be installed globally)
|
|
||||||
```sh
|
|
||||||
npx json-literal-typer -i <path to json> -o <path to output ts-file>
|
|
||||||
```
|
|
||||||
2. export default type from output file
|
|
||||||
|
|
||||||
<!-- PARTICIPANTS -->
|
|
||||||
|
|
||||||
## Participants
|
|
||||||
|
|
||||||
- [@AlexandrPrimakov](https://git.bro-js.ru/primakov)
|
|
||||||
- [@Ilnaz](https://git.bro-js.ru/237x237)
|
|
||||||
- [@Rustam](https://git.bro-js.ru/Rustam)
|
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
||||||
|
|
||||||
<!-- MARKDOWN LINKS & IMAGES -->
|
|
||||||
|
|
||||||
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
|
|
||||||
[React-url]: https://reactjs.org/
|
|
||||||
Loading…
Reference in New Issue
Block a user