Notes Backend NodeJS

Описание проекта:

Проект представляет собой небольшое бэкенд приложение для работы с заметками. С помощью запросов можно создавать, получать, изменять и удалять заметки.

Основная цель проекта: изучение стека.

Стэк:

• NodeJS
• Express
• TS
• Prisma
• PostgreSQL
• Jest
• Helmet

Установка:

Для того, чтобы подготовить проект к работе необходимо:

1. Скачать проект
2. Выполнить команду npm install
3. Изменить креды PostgreSQL в файле .env (сейчас в файле рандомные данные для примера)
4. Выполнить команду npm run dev

Работа с проектом:

Работать с приложением можно через следующие запросы:

• GET: http://localhost:3030/api/notes/all - получаем все текущие заметки.

• DELETE: http://localhost:3030/api/notes/delete - удаляем заметку. Требует Body. Пример:

  {
      "id": "cmlcpgdgl000013u4i5jn7k8d"
  }

• POST: http://localhost:3030/api/notes/add - добавляем новую заметку. В ответ получаем саму заметку с id и датой добавления. Требует Body. Пример:

  {
      "title": "Третья заметка",
      "description": "Какой-то очень важный текст"
  }

• POST: http://localhost:3030/api/notes/get - получаем заметку. Требует Body. Пример:

  {
      "id": "cmlcpgdgl000013u4i5jn7k8d"
  }

• POST: http://localhost:3030/api/notes/update - обновляем текущую заметку. В ответ получаем обновленную заметку. Требует Body. Пример:

  {
    "id": "cmlck7h9o0000gi9e1upqlp09",
    "title": "Первая заметка (upd2)",
    "description": "Теперь не такой важный текст",
    "createdAt": "2026-02-07T16:59:34.572Z"
  }

Что можно было бы улучшить:

• Возможно, разрелить текущий Notes Router на разные контроллеры или объединить функционал в класс.
• Добавить валидацию через Middleware.
• Поработать над оптимизацией.