Node.js сервер для работы с комиксами

Описание

Этот сервер на Node.js с использованием Express и PostgreSQL предоставляет API для управления комиксами. Реализована аутентификация с JWT, а также CRUD-операции для работы с пользователями и комиксами. Реализована отправка PUSH уведомлений на мое Android приложение через Firebase Cloud Messaging Этот сервер необходим для работы моего нативного Android приложения ComicsApp - https://github.com/Serjik-Developer/ComicsApp

Установка

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

git clone <https://github.com/Serjik-Developer/ComicsApp-Backend.git>
cd <ИМЯ_ПАПКИ>


### 2. Установка зависимостей
```sh
npm install dotenv express pg jsonwebtoken cors body-parser firebase-admin

3. Создание `.env` файла

Создайте файл .env в корневой директории и укажите в нем параметры подключения к базе данных и JWT:

PORT=5432
PG_USER=<ВАШ_ПОЛЬЗОВАТЕЛЬ>
PG_HOST=<АДРЕС_СЕРВЕРА>
PG_DATABASE=<ИМЯ_БД>
PG_PASSWORD=<ВАШ_ПАРОЛЬ>
PG_PORT=5432
JWT_SECRET=<СЕКРЕТНЫЙ_КЛЮЧ>
FIREBASE_PROJECT_ID=<ID_ПРОЕКТА_FIREBASE>
FIREBASE_CLIENT_EMAIL=<ВАШ_FIREBASE_EMAIL>
FIREBASE_PRIVATE_KEY=<СЕКРЕТНЫЙ_КЛЮЧ_FIREBASE>

4. Получение всех секретных ключей

Ключ от базы данных вам предоставит ваш хостинг. Ключи для Firebase вы можете найти в настройках проекта после его создания

Запуск сервера

npm start

Сервер запустится на http://localhost:3000 или будет использовать порт который вам назначит ваш хостинг

API эндпоинты

Аутентификация

Регистрация пользователя

POST /api/user/register

{
  "login": "user123",
  "password": "securepassword",
  "name": "User Name"
}

Авторизация пользователя

POST /api/user/auth

{
  "login": "user123",
  "password": "securepassword"
}

Возвращает JWT-токен.

Получение информации о пользователе

GET /api/user

Изменение имени пользователя

PUT /api/user/name

{
  "name": "New Name"
}

Изменение пароля

PUT /api/user/password

{
  "currentPassword": "oldpass",
  "newPassword": "newpass"
}

Загрузка аватара

POST /api/user/avatar

{
  "avatar": "base64-кодировка изображения"
}

Удаление аватара

DELETE /api/user/avatar

Управление уведомлениями

PUT /api/user/notification_settings

{
  "enabled": true/false
}

Сохранение FCM токена

POST /api/user/fcm_token

{
  "token": "fcm_token_value"
}

Работа с комиксами

Получение всех комиксов

GET /api/comics

Получение комиксов текущего пользователя

GET /api/mycomics

Получение комикса по `id`

GET /api/comics/:id

Создание комикса

POST /api/comics

{
  "comic": {
    "id": "uuid",
    "text": "Название комикса",
    "description": "Описание комикса"
  },
  "pages": [
    {
      "pageId": "uuid",
      "comicsId": "uuid",
      "number": 1,
      "rows": 2,
      "columns": 3,
      "images": [
        {
          "id": "uuid",
          "cellIndex": 1,
          "image": "base64-кодировка"
        }
      ]
    }
  ]
}

Обновление комикса

PUT /api/comics/:id

Удаление комикса

DELETE /api/comics/:id

Получение информации о комиксе

GET /api/comics/:comicsId/info

Управление страницами комикса

Добавление новой страницы

POST /api/comics/pages/:comicsId

{
  "rows": 2,
  "columns": 3
}

Получение страницы

GET /api/comics/pages/:pageId

Удаление существующей страницы

DELETE /api/comics/pages/:pageId

Управление изображениями

Добавление нового изображения

POST /api/comics/pages/images/:pageId

{
  "cellIndex": 1,
  "image": "base64-кодировка"
}

Удаление существующего изображения

DELETE /api/comics/pages/images/:imageId

Обновление изображения

PUT /api/comics/pages/images/:imageId

{
  "image": "base64-кодировка"
}

Реакции на комиксы

Поставить/убрать лайк

POST /api/comics/:id/like

Проверить лайк

GET /api/comics/:id/like

Получить количество лайков

GET /api/comics/:id/likes/count

Добавить/удалить из избранного

POST /api/comics/:id/favorite

Проверить избранное

GET /api/comics/:id/favorite

Получить избранные комиксы

GET /api/user/favorites

Работа с пользователями

Получить информацию о пользователе

GET /api/users/:userId

Подписаться/отписаться

POST /api/users/:userId/subscribe

Проверить подписку

GET /api/users/:userId/subscribe

Получить подписчиков

GET /api/users/:userId/subscribers

Получить подписки

GET /api/users/:userId/subscriptions

Проверка работоспособности сервера

GET /health

Node.js Server for Comics

Description

This Node.js server using Express and PostgreSQL provides an API for managing comics. It includes authentication with JWT and CRUD operations for users and comics. This server is necessary for my native Android App application - https://github.com/Serjik-Developer/ComicsApp

Installation

1. Clone the repository

git clone <https://github.com/Serjik-Developer/ComicsApp-Backend.git>
cd <FOLDER_NAME>

2. Install dependencies

npm install dotenv express pg jsonwebtoken cors body-parser firebase-admin

3. Create a `.env` file

Create a .env file in the root directory and specify the database connection parameters and JWT settings:

PORT=5432
PG_USER=<YOUR_USER>
PG_HOST=<SERVER_ADDRESS>
PG_DATABASE=<DATABASE_NAME>
PG_PASSWORD=<YOUR_PASSWORD>
PG_PORT=5432
JWT_SECRET=<SECRET_KEY>
FIREBASE_PROJECT_ID=<FIREBASE_PROJECT_ID>
FIREBASE_CLIENT_EMAIL=<FIREBASE_CLIENT_EMAIL>
FIREBASE_PRIVATE_KEY=<FIREBASE_PRIVATE_KEY>

Start the Server

npm start

The server will start at http://localhost:3000

API Endpoints

Authentication

User Registration

POST /api/user/register

{
  "login": "user123",
  "password": "securepassword",
  "name": "User Name"
}

User Authentication

POST /api/user/auth

{
  "login": "user123",
  "password": "securepassword"
}

Returns a JWT token.

Get User Information

GET /api/user

Update User Name

PUT /api/user/name

{
  "name": "New Name"
}

Update Password

PUT /api/user/password

{
  "currentPassword": "oldpass",
  "newPassword": "newpass"
}

Upload Avatar

POST /api/user/avatar

{
  "avatar": "base64-encoded image"
}

Delete Avatar

DELETE /api/user/avatar

Notification Settings

PUT /api/user/notification_settings

{
  "enabled": true/false
}

Save FCM Token

POST /api/user/fcm_token

{
  "token": "fcm_token_value"
}

Comics Management

Get All Comics

GET /api/comics

Get User's Comics

GET /api/mycomics

Get Comic by `id`

GET /api/comics/:id

Create a Comic

POST /api/comics

{
  "comic": {
    "id": "uuid",
    "text": "Comic Title",
    "description": "Comic Description"
  },
  "pages": [
    {
      "pageId": "uuid",
      "comicsId": "uuid",
      "number": 1,
      "rows": 2,
      "columns": 3,
      "images": [
        {
          "id": "uuid",
          "cellIndex": 1,
          "image": "base64-encoded"
        }
      ]
    }
  ]
}

Update a Comic