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

Добро пожаловать в документацию Boilerplate. Это руководство поможет вам начать работу с настройкой и персонализацией вашего приложения.

Обзор

Boilerplate - это полный стартовый набор для создания современных веб-приложений с использованием Next.js, React и набора интегрированных функций. Он разработан, чтобы помочь вам запустить ваш стартап за дни, а не недели.

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

Следуйте этим шагам, чтобы запустить ваш проект:

1. Клонировать репозиторий

bash
git clone https://github.com/melnnik/devship.git

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

bash
npm install

3. Настроить переменные окружения

Переименуйте .env.example в .env.local

bash
mv .env.example .env.local

4. Запустить приложение

У вас есть два способа запустить приложение:

Вариант A: Использование скрипта rebuild-deps.sh

Этот скрипт автоматически перестроит зависимости и запустит приложение:

bash
./rebuild-deps.sh

Скрипт обновит все необходимые зависимости и настроит окружение для запуска приложения.

Вариант B: Использование Docker Compose

Если вы предпочитаете использовать Docker, выполните следующие команды:

bash
docker compose build

После сборки контейнеров запустите их:

bash
docker compose up -d

После запуска ваше приложение будет доступно по адресу http://localhost:3000

Структура проекта

Boilerplate следует структуре Next.js App Router с некоторыми дополнительными организационными элементами для ясности:

  • /app → Страницы (1 папка + page.js = 1 страница)
  • /app/api → API вызовы (1 файл = 1 API эндпоинт)
  • /components → React компоненты
  • /lib → Вспомогательные функции библиотек (Stripe и Resend, аутентификация и т.д.)

Следующие шаги

Теперь, когда вы настроили свой проект, вы можете изучить документацию, чтобы узнать больше о доступных функциях и компонентах: