YourPet Backend API

Це репозиторій проекту YourPet Backend API, який надає API для взаємодії з додатком YourPet.

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

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

Вимоги

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

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

Інсталяція

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

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

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

• npm start — старт сервера в режимі production

• npm run dev — старт сервера в режимі розробки (development)

• npm run lint — запустити виконання перевірки коду з eslint, необхідно виконувати перед кожним PR та виправляти всі помилки лінтера

• npm lint:fix — та ж перевірка лінтера, але з автоматичними виправленнями простих помилок

• /docs — swagger documentation.