https://github.com/code-418-dpr/kntista-frontend

Фронтенд для проекта KNTista
https://github.com/code-418-dpr/kntista-frontend

docker frontend heroui kntista microservice nextjs

Last synced: 6 months ago
JSON representation

Фронтенд для проекта KNTista

• Host: GitHub
• URL: https://github.com/code-418-dpr/kntista-frontend
• Owner: code-418-dpr
• License: mit
• Created: 2025-03-25T15:26:54.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-03-25T17:05:43.000Z (6 months ago)
• Last Synced: 2025-03-25T18:23:32.382Z (6 months ago)
• Topics: docker, frontend, heroui, kntista, microservice, nextjs
• Language: JavaScript
• Homepage:
• Size: 109 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# KNTista-frontend

[![license](https://img.shields.io/github/license/code-418-dpr/KNTista-frontend)](https://opensource.org/licenses/MIT)

[![release](https://img.shields.io/github/v/release/code-418-dpr/KNTista-frontend?include_prereleases)](https://github.com/code-418-dpr/KNTista-frontend/releases)

[![downloads](https://img.shields.io/github/downloads/code-418-dpr/KNTista-frontend/total)](https://github.com/code-418-dpr/KNTista-frontend/releases)

[![code size](https://img.shields.io/github/languages/code-size/code-418-dpr/KNTista-frontend.svg)](https://github.com/code-418-dpr/KNTista-frontend)

[![linters](https://github.com/code-418-dpr/KNTista-frontend/actions/workflows/linters.yaml/badge.svg)](https://github.com/code-418-dpr/KNTista-frontend/actions/workflows/linters.yaml)

[![codeql](https://github.com/code-418-dpr/KNTista-frontend/actions/workflows/codeql.yaml/badge.svg)](https://github.com/code-418-dpr/KNTista-frontend/actions/workflows/codeql.yaml)

[![build](https://github.com/code-418-dpr/KNTista-frontend/actions/workflows/build.yaml/badge.svg)](https://github.com/code-418-dpr/KNTista-frontend/actions/workflows/build.yaml)

Модуль фронтенда для проекта [KNTista](https://github.com/code-418-dpr/KNTista)

## Особенности реализации

- ...

## Стек

- **Bun** — быстрая среда исполнения JavaScript

- **TypeScript** — статически типизированный JavaScript

- **Next.js** — фронтенд-фреймворк на основе React

- **Tailwind CSS** — CSS-фреймворк

- **HeroUI** — набор компонентов

- **ESLint** — статический анализатор кода

- **Stylelint** — анализатор стилей

- **Prettier** — форматировщик кода

- **Docker** — платформа для контейнеризации

## Установка и запуск

> [!WARNING]

> Полноценная работа фронтенда возможна только при запущенном бэкенде.

0. Клонируйте репозиторий и перейдите в его папку.

### Посредством Docker

1. Установите Docker.

2. Создайте файл `.env` на основе [.env.template](.env.template) и настройте все описанные там параметры.

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

```shell

docker build -t kntista-frontend .

```

4. Теперь запускать образ можно командой:

```shell

docker run -d --name kntista-frontend-standalone -p 8000:3000 kntista-frontend

```

### Без использования Docker

1. Установите Bun одним из способов. Например, для Windows:

```shell

powershell -c "irm bun.sh/install.ps1 | iex"

```

2. Установите зависимости:

```shell

bun install

```

3. Создайте файл `.env` на основе [.env.template](.env.template) и настройте все описанные там параметры.

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

```shell

bun run build

```

5. Теперь запускать проект можно командой:

```shell

bun run start

```

## Модификация

Запуск сервера в режиме отладки осуществляется командой:

```shell

bun run dev

```

Прочие скрипты, необходимые для запуска линтеров, форматировщика и т. д. находятся в

файле [package.json](./package.json).