Створення проєкту вашого бота

Тепер, коли у вас встановлено Node.js і налаштовано акаунт бота, настав час створити ваш перший проєкт yurba.js. Цей посібник проведе вас через налаштування професійної структури проєкту з належним управлінням конфігурацією та практиками безпеки.

Ініціалізація проєкту

Крок 1: Створення директорії проєкту

Спочатку створіть окрему директорію/папку для вашого бот-проєкту:

cd my-yurba-bot

Крок 2: Ініціалізація Package.json

Ініціалізуйте ваш Node.js проєкт, використовуючи ваш улюблений менеджер пакетів:

npm

npm init

yarn

yarn init

pnpm

pnpm init

bun

bun init

Вас попросять заповнити інформацію про проєкт. Ось приклад конфігурації:

Крок 3: Перевірка Package.json

Після ініціалізації ваш package.json повинен виглядати приблизно так:

{
  "name": "my-yurba-bot",
  "version": "1.0.0",
  "description": "A powerful bot built with yurba.js",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": ["yurba", "bot", "yurba.js", "automation"],
  "author": "Your Name",
  "license": "MIT"
}

Файли конфігурації

Створіть файл .env та файл config.json

.env

YURBA_TOKEN=your-token-here

config.json

{
  "prefix": "/"
}

Попередження про безпеку

Ніколи не комітьте чутливі файли, такі як .env або config.json, що містять токени, до системи контролю версій. Ці файли містять приватні облікові дані, які повинні зберігатися в безпеці.

Переконайтеся, що додали ці файли до вашого .gitignore, щоб запобігти випадковим комітам.

Налаштування Git

Що таке Git?

Git — це розподілена система контролю версій, яка допомагає відстежувати зміни у вашому коді, співпрацювати з іншими та керувати різними версіями вашого проєкту.

Ініціалізація Git

git init

TIP

Якщо ви використовуєте GitHub або GitLab, ви можете ініціалізувати ваш репозиторій за допомогою цих команд:

GitHub

git remote add origin https://github.com/username/repository-name.git
git branch -M main
git push -u origin main

GitLab

git remote add origin https://gitlab.com/username/repository-name.git
git branch -M main
git push -u origin main

Створення .gitignore

Створіть вичерпний файл .gitignore, щоб виключити чутливі та непотрібні файли:

Що таке `.gitignore`?

Файл .gitignore вказує, які файли та директорії Git повинен ігнорувати і не відстежувати в системі контролю версій. Будь-які файли або папки, перелічені в .gitignore, не будуть включені в git коміти.

.gitignore

# Dependencies
node_modules/

# Environment variables and configuration
.env

з config.json

# Залежності
node_modules/
config.json # якщо містить токени або іншу чутливу інформацію

# Змінні середовища та конфігурація
.env