Начало работы

Облако

Самостоятельный хостинг требует больше технических навыков для настройки сервиса, резервного копирования базы данных и обслуживания обновлений. Если у вас нет опыта управления серверами и вы просто хотите использовать веб-приложение, рекомендуется воспользоваться OSMI Cloud.

Быстрый старт

Установите OSMI локально с помощью NPM:

1. Установка OSMI:

npm install -g OSMI

Вы также можете установить конкретную версию: см. доступные версии.

npm install -g OSMI@x.x.x

2. Запуск OSMI:

npx OSMI start

3. Открыть: http://localhost:3000

Docker

Существует два способа развернуть OSMI с помощью Docker.
Сначала клонируйте репозиторий: OSMI используя git clone

Docker Compose

1. Перейдите в папку docker в корне проекта.
2. Скопируйте файл .env.example и сохраните копию под именем .env
3. Выполните команду:

docker compose up -d

4. Откройте приложение в браузере на локальном порту 3000 Пример: http://localhost:3000
5. Чтобы остановить контейнеры, выполните:

docker compose stop

Docker Image

1. Соберите образ:

docker build --no-cache -t osmi .

2. Запустите образ:

docker run -d --name osmi -p 3000:3000 osmi

3. Для остановки контейнера:

docker stop osmi

Для разработчиков

OSMI состоит из 4 модулей в едином моно-репозитории:

• Server: сервер на Node.js для API логики
• UI: фронтенд на React
• Components: компоненты для интеграции
• Api Documentation: спецификация Swagger для API OSMI

Предварительное условие

Установите PNPM.

npm i -g pnpm

Настройка 1

Простая установка с использованием PNPM:

1. Клонируйте репозиторий OSMI

git clone репозиторий OSMI

2. Перейдите в каталог проекта

cd osmi

3. Установите зависимости во всех модулях:

pnpm install

4. Соберите проект:

pnpm build

Запустите приложение на локальном порту http://localhost:3000

pnpm start