Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
0niel authored Jan 26, 2025
1 parent dba9d99 commit 99c6cf9
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,34 +18,46 @@


# Установка и конфигурация проекта
_Перед началом убедитесь, что у вас установлен JDK 17._
Для сборки и запуска данного проекта необходима **Java 17**.

1. [Установите стабильную версию Flutter](https://docs.flutter.dev/get-started/install) для своей операционной системы, если вы этого ещё не сделали. Используйте `flutter doctor` для проверки установки и конфигурации Flutter.

Этот проект использует некотоыре пакеты, которые необходимо установить перед началом работы:
- [fvm](https://pub.dev/packages/fvm) для управления версиями Flutter.
- [melos](https://pub.dev/packages/melos) для управления подпакетами.

2. Установите fvm и melos:
2. Клонирование репозитория:
```bash
git clone https://github.com/0niel/university-app.git
```
или форкните репозиторий и клонируйте свой форк.

2.1. Инициализация и обновление submodules:
В проекте используются *Git submodules* (в директории packages/neon и других). После клонирования репозитория необходимо проинициализировать и обновить submodules:
```bash
git submodule update --init --recursive
```

3. Установите fvm и melos:
```bash
dart pub global activate fvm
dart pub global activate melos
```

3. Используйте fvm в корневой директории проекта для установки версии Flutter, необходимой для работы над проектом:
4. Используйте fvm в корневой директории проекта для установки версии Flutter, необходимой для работы над проектом:
```bash
fvm install
fvm flutter precache
```

4. Используйте melos в корневой директории проекта для установки зависимостей всех подпакетов:
5. Используйте melos в корневой директории проекта для установки зависимостей всех подпакетов:
```bash
melos bootstrap
```

Важно: Если ваш терминал не распознает команды `fvm` и `melos`, убедитесь, что Pub Cache находится в вашем `PATH`. Подробнее об этом можно прочитать [здесь](https://dart.dev/tools/pub/cmd/pub-global).

5. После установки всех зависимостей, вы можете запустить проект, выполнив команду:
6. После установки всех зависимостей, вы можете запустить проект, выполнив команду:
```bash
fvm flutter run
```
Expand Down Expand Up @@ -85,21 +97,12 @@ flutter doctor


## Переменные окружения
Приложение использует переменные среды времени компиляции для хранения конфиденциальных данных, таких как ключи API и токены.

Эти переменные должны передаваться при запуске или сборке приложения с помощью аргумента `--dart-define` или установленной переменной окружения. Если вам нужно передать несколько пар ключ-значение, просто определите --dart-define несколько раз.
Приложение использует переменные среды для хранения конфиденциальных данных, таких как ключи API и токены. См. файл `.env.example`.

### Переменные приложения, используемые в проекте:
- `SENTRY_DSN` - DSN для отправки отчетов об ошибках в Sentry (необязательно).
- `LK_CLIENT_ID` - ID клиента для авторизации в Личном кабинете с помощью OAuth2.
- `LK_CLIENT_SECRET` - Секретный ключ клиента для авторизации в Личном кабинете с помощью OAuth2.

**Пример:**
```bash
fvm run --dart-define=SENTRY_DSN=YOUR_DSN --dart-define=LK_CLIENT_ID=YOUR_CLIENT_ID --dart-define=LK_CLIENT_SECRET=YOUR_CLIENT_SECRET
```

Если LK_CLIENT_ID и LK_CLIENT_SECRET не будут переданы, приложение будет работать в режиме "без авторизации", а пользователь не сможет войти в Личный кабинет.
- `STORYLY_ID` - API ключ для работы Сторис через Storyly (необязательно).
- `MAPKIT_API_KEY` - API ключ для работы с Яндекс Картами (Yandex MapKit) (необязательно).


# Запуск API сервера
Expand Down

0 comments on commit 99c6cf9

Please sign in to comment.