diff --git a/.readme-static/competition.png b/.readme-static/competition.png new file mode 100644 index 0000000..dbdc1df Binary files /dev/null and b/.readme-static/competition.png differ diff --git a/.readme-static/learn_fail.png b/.readme-static/learn_fail.png new file mode 100644 index 0000000..9cb1d5b Binary files /dev/null and b/.readme-static/learn_fail.png differ diff --git a/.readme-static/learn_success.png b/.readme-static/learn_success.png new file mode 100644 index 0000000..999ee0c Binary files /dev/null and b/.readme-static/learn_success.png differ diff --git a/.readme-static/main_menu.png b/.readme-static/main_menu.png new file mode 100644 index 0000000..92c7020 Binary files /dev/null and b/.readme-static/main_menu.png differ diff --git a/README.md b/README.md index dd01528..e7dd325 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,41 @@ -## Тема: -### Мини-игры для развития определенных навыков в программировании -> Описание: -> -> Гонки на регулярках. -> Микросервисы бла-бла lorem text... +# CodeQuest +> Проект реализован в рамках development hackathon.
+> Тема: Мини-игры для развития определенных навыков в программировании -## GitFlow: -- В ветке `master` проект готовый к релизу -- В `develop` ведем разработку и вмерживаем ветки фич -- Под каждый сервис своя ветка -(директория сервиса располагается в корневом каталоге проекта) -![gitflow](./.readme-static/gitflow.jpg) +> Авторы: [Дюсенов Асет](https://dyussenov.dev/), [Ким Максим](https://github.com/exynil), [Песков Сергей](https://peskov.dev/) - И не забывайте, 1 готовый блок кода (фича) = 1 коммит. +CodeQuest - игровая платформа представляющая коллекцию игр для разивтия определенных +скиллов в программировании. В качестве mvp представленна игра: **Гонки на регулярках** + -## Setup: +## RegexRace +Регулярки в языках программирования это очень мощный инструмент, +но к сожалению у многих он хромает. + +**RegexRace** имеет 2 режима: +1) Обучающий режим. Блок с теорией позволяющий подятнуть базу по регуляркам + + +2) Рейтинговый режим - позволяет пользователям соревноваться в написании регулярок на перегонки. + + +# Setup: - `git clone https://github.com/codequest-team/codequest.git` - `cd codequest` -- In the root of the project create `.env` file (and substitute your values if necessary): +- copy .envs and substitute your values if necessary: + ```bash + cp -r .envs_example .envs + ``` +- generate docker-compose with `docker-compose.sh` (param `dev` for local lauch) + ```bash + ./docker-compose.sh dev + ``` + or + ```bash + ./docker-compose.sh prod ``` - echo 'JWT_SECRET_KEY="e7c83a28f8b8d597afedf2134979ed8ae9f472d1"' > .env +- run project + ```bash + docker-compose up --build ``` -- `docker-compose up --build`