Shareit

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

Оглавление

• API проекта
• Инструкция по установке
• Технологический стек

API проекта

Не устанавливая проект

Для того чтобы ознакомиться с API проекта:

1. Скопируйте ссылку:

https://raw.githubusercontent.com/BucketOnHead/java-shareit/main/shareit-open-api-spec.yaml

2. Перейдите по ссылке: https://editor-next.swagger.io/ (если ссылка не работает, найдите в браузере swagger editor)

3. Выберете на сайте File > Import URL и вставьте скопированную ссылку

Если проект установлен

Если вы уже установили проект, то после запуска сервиса gateway вы можете ознакомиться с API проекта по ссылке:

http://localhost:8080/swagger-ui/index.html

Инструкция по установке

• Требования
• Установка
• Запуск

Требования

• Git
• Docker
• JDK 11 или выше
• Apache Maven 3.6.0 или выше

Установка

1. Склонируйте репозиторий на свой компьютер с помощью команды:

git clone https://github.com/BucketOnHead/java-shareit.git

2. Перейдите в директорию проекта:

cd java-shareit

3. Соберите проект с помощью Apache Maven:

mvn clean install

Запуск

После установки проекта, вы можете запустить его с помощью команды:

sudo docker-compose up -d

Технологический стек

• Java 11
• Spring Boot 2
• ORM: Hibernate, Spring Data JPA
• Apache Maven
• Docker: dockerfile, docker-compose
• Swagger: springdoc