/Drink-Master-Backend-API

Backend REST API

Primary LanguageHTML

Drink Master Backend API

Це репозиторій проекту Drink Master Backend API, який надає API для взаємодії з додатком project-drink-master.

Огляд проекту

Цей проект реалізує серверну частину додатку project-drink-master. Він побудований на Node.js, використовуючи фреймворк Express.js для реалізації API та Mongoose для взаємодії з базою даних MongoDB, cludinary як медія сховище.

Документація

Кожен ендпоїнт веб серверу розписаний на Swagger(openAPI)

Вимоги

Перед початком роботи з проектом, впевніться, що на вашому комп'ютері встановлені наступні засоби:

  • Node.js (версія 16 або вище)

Інсталяція

  1. Склонуйте цей репозиторій на свій локальний комп'ютер.
  2. Відкрийте термінал і перейдіть до кореневої папки проекту.
  3. Виконайте команду npm install для встановлення залежностей проекту.
  4. Виконайте команду npm start для запуску веб серверу додатка

Конфігурація

  1. Створіть файл .env у кореневій папці проекту.
  2. Вкажіть необхідні змінні середовища в цьому файлі, приклади змінних розташовані в файлі .env.example.

Особливості

  • RESTful API
  • CRUD оперції
  • JWT аутентифікація та refresh авторизація
  • Google OAUTH2
  • cloudinary як медіа файлове сховище
  • гнучкі параметри пошуку
  • сортування елементів по поулярності та новизні
  • Sendgrid поштова розсилка