sequelize-game-bank
v5.1.4
Published
A Sequelize-based gaming economy and banking system featuring user profiles, credits, admin management, and detailed transaction history.
Maintainers
Readme
sequelize-game-bank
npm модуль для создания полноценного банка на express, sequelize (sqlite).
О проекте
sequelize-game-bank — это готовый бэкенд-модуль, который за пару строк кода разворачивает изолированную банковскую систему для вашей игры или тестовой среды. Он автоматически создает базу данных SQLite через Sequelize и монтирует защищенные REST API роуты для Express.
- Изолированная песочница: Идеально для безопасной симуляции балансов, переводов и транзакций без риска реальных денег.
- Всё включено: База данных (SQLite), модели (Sequelize) и готовые эндпоинты (Express) поставляются в одном пакете.
- Быстрый старт: Не требует настройки внешних баз данных — всё работает "из коробки" в локальном файле или памяти.
- Поддержка Nodemailer Возможность отправлять сообщения на gmail
🚀 Установка
Установите пакет через менеджер пакетов:
npm install sequelize-game-bank
# или
yarn add sequelize-game-bankУстановка и настройка (Инициализация)
Модуль sequelize-game-bank требует асинхронной инициализации базы данных и настройки роутов.
1. Настройка окружения (.env)
После первого запуска откройте .env и настройте эти поля:
SEQUELIZE_GAME_BANK_INITIALIZED = true
JWT_SECRET = 0000
ROOT_PASSWORD = bank-root
GMAIL =
GOOGLE_APP_PASSWORD = 2. Подключение в проект
Так как модуль является асинхронным, его необходимо подключать ДО финальных обработчиков несуществующих маршрутов (404) и ошибок сервера (500). Поместите вызов модуля внутрь асинхронного блока:
const express = require('express');
const sequelize_game_bank = require('sequelize-game-bank');
const app = express();
(async () => {
try {
await sequelize_game_bank(app);
app.use((req, res) => {
res.status(404).send("<h1>404 - Страница не найдена</h1>");
});
app.use((err, req, res, next) => {
res.status(500).send("<h1>500 - Внутренняя ошибка сервера</h1>");
});
} catch (error) {
}
})();
module.exports = { app };🌐 Маршрутизация и точки входа (v4.0.0)
В версии 4.0.0 вся логика путей полностью изолирована внутри модуля и работает в автоматическом режиме. Разработчику или пользователю доступны всего 3 основные веб-страницы для ручного перехода из браузера:
GET/bank/home.html— Главная приветственная страница банка.GET/bank/login.html— Страница авторизации пользователей.GET/bank/register.html— Страница регистрации новых аккаунтов.
⚙️ Как это работает изнутри (Автоматика модуля)
Вам больше не нужно вручную настраивать эндпоинты в основном проекте CITY. После подключения модуля в server.js автоматически разворачиваются два изолированных роутера:
Интерфейс банка (Префикс
/bank)
Автоматически управляет отображением всех внутренних страниц личного кабинета (панели управления, счета, переводы, кредиты, админка) и раздачей статических файлов (CSS, JS, загруженные аватарки).Серверное API (Префикс
/api/bank)
Полностью берет на себя фоновый обмен JSON-данными между вашим фронтендом и базой данных Sequelize. На этот префикс автоматически завязаны все типы сетевых операций:- Получение данных (
GETзапросы профилей, счетов, баланса и истории логов). - Изменение состояния (
POSTзапросы авторизации, переводов, кредитов и настройки 2FA). - Удаление сущностей (
DELETEзапросы на закрытие игровых счетов).
- Получение данных (
