em-shop/users/README.md

81 lines
2.5 KiB
Markdown
Raw Normal View History

2024-11-20 09:53:03 +05:00
### Users
Backend users v0.1
Repository name: `em-shop`
Swagger: `http://localhost/users/api/docs/`
--------------------------------------------------------------------
*cheat sheet:*
```sh
# Запуск сервера в production mode:
sudo bash run.prod.sh
sudo docker compose up -d --build --force-recreate
# Запуск сервера в development mode:
sudo bash run.dev.sh
sudo docker compose -f docker-compose.dev.yml up --build --force-recreate
# Подключение к консоли контейнера:
sudo docker exec -it users sh
sudo docker exec -it users-dev sh
sudo docker start users
sudo docker stop users
sudo docker start users-dev
sudo docker stop users-dev
```
--------------------------------------------------------------------
#### Общие сведения
Для успешного запуска и функционирования требуются следующий файл конфигурации:
```yml
env_file:
- ./config.env
```
В `config.env` указываюся переменные:
(Используйте эти значения только для разработки)
```conf
PORT=3003
URL=/users/api
POSTGRES_HOST=postgres
POSTGRES_PORT=5432
POSTGRES_USER=postgres
POSTGRES_DB=postgres
POSTGRES_PASSWORD=2wroxrnr8fdxicvw2nsd
```
#### Production mode:
Режим запуска сервера по умолчанию.
Конфигурация описана в `docker-compose.yml`
Запуск сервера осуществляется простой командой:
`docker compose up -d`
После изменений в образе, запуск производится с пересборкой образа:
`docker compose up -d --build --force-recreate`
Для быстрого удобного запуска предусмотрен `скрипт run.prod.sh`, который выполняет команду выше.
#### Development mode:
Запуск сервера в режиме разработки. Требуется указать соответствующий образ:
`docker compose -f docker-compose.dev.yml up -d`
После изменений в образе, запуск производится с пересборкой образа:
`docker compose -f docker-compose.dev.yml up -d --build --force-recreate`
Для быстрого удобного запуска предусмотрен скрипт `run.dev.sh`, который выполняет команду выше.