Skip to content

dzemlyakov/news_api

Repository files navigation

News-api

Backend application for diploma-project - Бэкенд для сервиса News analyzer. Version: v.1.0.0

Описание

Серверная часть дипломного проекта для Яндекс.Практикума. Данное приложение служит для хранения пользователей и их статей. Одна из основных задач – создание виртуальной машины и деплой проекта на публичный сервер. В данной работе отрабатываются навыки по взаимодействию с Node.js, Express.js, MongoDB, развёртывание сервера на удалённой виртуальной машине.

Инструкция для запуска

Локальный запуск

  1. Клонировать репозиторий
  2. Установить модули npm с помощью команды:
        npm install
    
  3. Подключиться к базе Mongo с помощью команды:
        mongod
    
  4. Локально запустить сайт по адресу http://localhost:3000 можно с помощью команды:
        npm run start
    
  5. Запуск с hot-reload осуществляется по команде:
        npm run dev
    
  • Запрос POST /signup создаёт пользователя (в теле запроса необходимо предавать json-объект с полями "name", "email", "paswsword");
  • Запрос POST /signin вход пользователя(в теле запроса необходимо предавать json-объект с полями "email" и "password");
  • Запрос GET /users/me выдаёт информацию об авторизованном пользовтеле;
  • Запрос на POST /articles создаёт статью (в теле запроса необходимо предавать json-объект с полями "keyword", "title", "text", "date", "source", "link", "image");
  • Запрос DELETE /articles/:id удаляет статью по id;

About

Node.js + Express.js + MongoDB REST API

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors