Перейти до вмісту
Relidocs: Reliverse Docs

Installation

[Bootstrap Relivator зі стеком на ваш вибір за допомогою Reliverse CLI]

Як встановити та розпочати роботу: У вас є два варіанти встановлення. Ви можете або одразу розгорнути у Vercel за допомогою кнопки нижче і почати працювати зі згенерованим репозиторієм (але все одно прочитайте інформацію нижче), або ви можете слідувати коротким або детальним інструкціям з інсталяції, що надаються в посібнику. До речі: Іноді ми даруємо Reliverse Pro, який надає ранній доступ до екосистеми проектів Reliverse, включаючи Relivator, а також майбутні плагіни, випадково обраним особам. Ми також роздаємо інші цікаві речі. Просто «позначте цей репозиторій» і повідомте нам, як з вами зв’язатися. Щоб приєднатися до обговорення, перейдіть на Discord проекту.

Спосіб встановлення в один клік (знайдіть рекомендований спосіб нижче)

🔥 Важливе зауваження: Relivator наразі вимагає вказівки ключів змінних оточення Clerk, оскільки його API було змінено. Ми працюємо над тим, щоб зробити Clerk знову необов’язковим. Однак, всі інші змінні оточення є необов’язковими. Якщо це твердження невірне і щось зламано, будь ласка, повідомте нам про це. Використовуючи цей метод, ви отримаєте лише фронтенд, з вимкненим функціоналом (дізнайтеся, як його увімкнути, прочитавши інструкцію нижче): Розгортання за допомогою Vercel Зверніть увагу: Починаючи з версії 1.2.6 та 1.3.0 (dev та canary), рекомендується використовувати Clerk як authProvider (вказано у файлі reliverse.config.ts), оскільки ця версія була більш ретельно протестована з Clerk. Ми працюємо над виправленням та покращенням стабільності Auth.js (next-auth@beta/NextAuth.js) як провайдера автентифікації.

Встановлення вручну: Короткий метод (знайти рекомендований метод нижче)

🔥 Важливе зауваження: Relivator наразі вимагає вказівки ключів змінних оточення Clerk, оскільки його API було змінено. Ми працюємо над тим, щоб знову зробити Clerk необов’язковою. Однак, всі інші змінні оточення є необов’язковими. Якщо це твердження невірне і щось зламано, будь ласка, повідомте нам про це.

  1. Node.js LTS: (A) класичний метод - Windows/macOS | Linux; (B) nvm - Windows | macOS/Linux; (C) fnm.
  2. Tools: corepack enable pnpm ➞ VSCode ➞ Git ➞ GitHub Desktop (Windows/macOS | Linux) ➞ Stripe CLI. Тільки для Windows: PowerShell 7.4+.
  3. Форк репозиторію: Завантажте форк за допомогою GitHub Desktop.
  4. Встановлення: bun install && install:global && bun reli:setup ➞ bun reli:vscode ➞ cp .env.example .env ➞ заповніть значення всередині .env ➞ bun db:push ➞ reliverse.config.ts.
  5. Запуск, збірка, розгортання: Використовуйте bun run dev для запуску програми. Зупиніть за допомогою Ctrl+C. Зберіть за допомогою bun run build. Запустіть bun appts для перевірки коду. Завантажте на GitHub за допомогою GitHub Desktop. Розгорнути на Vercel.

Встановлення вручну: Детальний метод (рекомендовано)

🔥 Важливе зауваження: Relivator наразі вимагає вказівки ключів змінних середовища Clerk, оскільки його API змінився. Ми працюємо над тим, щоб зробити Clerk знову необов’язковим. Однак, всі інші змінні оточення є необов’язковими. Якщо це твердження невірне і щось зламано, будь ласка, повідомте нам про це. ▲ Гаряча лінія: Email | Discord | Slack | Cal.com

Я (blefnk) працюю над тим, щоб максимально автоматизувати процес встановлення Relivator. У майбутній версії 1.3.0 буде суттєво автоматизовано процес встановлення. Якщо ви бажаєте спробувати альфа-версію одного з моїх численних сценаріїв автоматизації, скористайтеся командою bun deps:install (або bun deps:install-all). Однак перед запуском цього скрипта вам слід вручну встановити основні компоненти (відредагуйте ‘bunx jsr’, якщо потрібно): npx nypm add typescript tsx @clack/prompts @mnrendra/read-package nypm ora fs-extra pathe fast-npm-meta semver @types/semver redrun && bunx jsr add @reliverse/core. Зверніть увагу: Починаючи з версії 1.2.6 та 1.3.0 (dev та canary), рекомендується використовувати Clerk як authProvider (вказано у файлі reliverse.config.ts), оскільки ця версія була більш ретельно протестована з Clerk. Ми працюємо над виправленням та покращенням стабільності Auth.js (next-auth@beta/NextAuth.js) як провайдера автентифікації.

  1. Node.js LTS: Переконайтеся, що у вас встановлено Node.js LTS за допомогою: (a) класичним методом - Windows/macOS | Linux; (b) nvm - Windows | macOS/Linux; (c) fnm.
  2. Essential Tools: Запустіть corepack enable pnpm, щоб встановити pnpm. Також встановіть VSCode, Git, GitHub Desktop (Windows/macOS | Linux) та Stripe CLI. Якщо ви користувач Windows: також встановіть PowerShell 7.4+.
  3. Клонування проекту: Розгалуження сховища або натисніть на кнопку Використовувати цей шаблон. Використовуйте GitHub Desktop, щоб завантажити його на свій пристрій. Розмір проекту становить близько 12 МБ, але для комфортної роботи переконайтеся, що у вас є не менше 7 ГБ дискового простору, оскільки папки node_modules і .next вимагають цього.
  4. Налаштування: Відкрийте папку проекту у VSCode. Встановіть рекомендовані розширення з .vscode/extensions.json та/або встановіть розширені конфігурації VSCode за допомогою bun reli:vscode (виберіть default для найкращого досвіду або ultimate для найкращого досвіду). Ви також можете звернутися до ⚙️ Скрипти і 🤔 FAQ RQ19 нижче, щоб дізнатися більше про цей скрипт і його конфігурації. Ви можете натиснути Cmd/Ctrl+F і знайти «Q19/Q20», якщо ви хочете встановити більше розширень і налаштувань (пам’ятайте, що більше розширень означає повільнішу роботу VSCode). Потім натисніть File > Exit (VSCode збереже всі ваші відкриті вікна). Знову відкрийте VSCode. Натисніть Ctrl+Shift+P (або просто F1) і знайдіть >Створити новий термінал, або просто натисніть Cmd/Ctrl+Shift+~ (у Windows переконайтеся, що використовується PowerShell 7.4+, натисніть стрілку біля + ➞ Виберіть профіль за замовчуванням ➞ PowerShell). Якщо VSCode попросить вас дозволити використання версії TypeScript проекту, дозвольте це, якщо ви користувач Windows. В інших операційних системах ви можете зіткнутися з проблемою шляху, а можете і не зіткнутися.
  5. Навколишнє середовище: Запустіть bun install (або npx nypm install) та/або, за бажанням, install:global для встановлення необхідних пакунків. Також рекомендується налаштувати файл reliverse.config.ts. Потім, за бажанням, ви можете скористатися bun deps:install-all - особливо bun deps:install-all (це наразі альфа-версія скрипту)- для розблокування деяких додаткових можливостей, наприклад, попередньо встановленого eslint.config.ultimate.ts (який за замовчуванням матиме розширення .txt, починаючи з Relivator v1.3.0). (ПРИМІТКА: Починаючи з Relivator v1.2.6, за замовчуванням налаштовано ultimate пресет, тому жодних дій не потрібно). Далі налаштуйте Relivator відповідно до ваших потреб за допомогою команд bun reli:setup та/або bun reli:vscode і перезапустіть VSCode. У вас є два варіанти: розгортання з нульовими значеннями у файлі .env (в результаті чого ви отримаєте лише інтерфейс без функцій, пов’язаних з авторизацією, базою даних, ціноутворенням тощо), або скопіюйте файл .env.example до нового файлу .env і заповніть його потрібними вам значеннями (все це необов’язково, починаючи з Relivator v1.2.6). Наполегливо рекомендується заповнити поле DATABASE_URL. Потім встановіть провайдера бази даних у файлі drizzle.config.ts і внесіть зміни у пов’язані файли, якщо це необхідно. Нарешті, надішліть схему бази даних до бази даних за допомогою bun db:push. Ви можете дізнатися більше про бази даних нижче у поточному файлі README.md.
  6. Запуск, зупинка, збірка: Запустіть програму за допомогою bun run dev або bun turbo:dev (інтерактивно, але нестабільно). Відвідайте http://localhost:3000, щоб перевірити це. Зупиніть його, сфокусувавшись на консолі і натиснувши Ctrl+C. Після внесення змін зберіть програму за допомогою bun run build або bun turbo:build. Не хвилюйтеся, якщо під час запуску збірки ви побачите попередження, пов’язані з Clerk, React Compiler, Babel, next-auth тощо; це відомі проблеми, не пов’язані з Relivator. Зверніть увагу, що при використанні команди bun turbo:build термінал VSCode може не завершити роботу автоматично. Якщо це сталося, натисніть комбінацію клавіш Cmd/Ctrl+C, щоб завершити процес вручну.
  7. Перевірка, фіксація, розгортання: Щоб перевірити, чи відповідає поточна кодова база @reliverse/standard, запустіть bun appts (або bun appts:noputout, або bun turbo:appts, або bun appts:nobuild). Дізнайтеся більше про скрипти проекту у наступному розділі. Якщо все гаразд, завантажте проект до свого профілю на GitHub за допомогою GitHub Desktop. Нарешті, розгорніть його, імпортувавши проект у Vercel, зробивши веб-сайт загальнодоступним в Інтернеті. Крім того, ви можете використовувати bun deploy або просто vercel для попереднього перегляду та перевірки локального розгортання без необхідності щоразу вносити зміни до GitHub. Рекомендується: Час від часу запускайте bun reli:prepare. Цей скрипт виконує bun install, який перевіряє наявність проблем або встановлює/видаляє вручну додані/видалені залежності у вашому файлі package.json. Він також виконує bun latest, який встановлює найновіші версії залежностей проекту. Нарешті, він запускає bun appts, який зробить все можливе, щоб покращити ваш код і перевірити його на наявність помилок. Примітка: Оскільки bun latest оновлює всі пакунки до їхніх останніх версій, пам’ятайте, що щось у коді може зламатися, особливо якщо з моменту випуску останньої версії Relivator пройшло багато часу. Тому ви можете скористатися, наприклад, розширенням VSCode Open Multiple Files, щоб легко знайти і виправити несправний код, або звернутися за допомогою до Relivator Discord server, або створити GitHub Issue. Ви можете дізнатися більше про ці скрипти та згадане розширення нижче у поточному файлі README.md. Якщо ви хочете поділитися своєю роботою, отримати/надати відгук або попросити про допомогу, не соромтеся робити це або на нашому сервері Discord, або за допомогою обговорень на GitHub. Примітка: Наразі наведені вище інструкції можуть бути застарілими. Будь ласка, зв’яжіться з нами, якщо щось піде не так; все буде оновлено у Relivator 1.3.0.