Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bucketonhead/java-shareit
RESTful platform for item exchange: find, share, rent.
https://github.com/bucketonhead/java-shareit
docker-compose docker-file dto gateway hibernate java-11 lombok mapstruct maven postman-collection slf4j spring-boot spring-doc swagger
Last synced: 4 days ago
JSON representation
RESTful platform for item exchange: find, share, rent.
- Host: GitHub
- URL: https://github.com/bucketonhead/java-shareit
- Owner: BucketOnHead
- Created: 2022-11-17T11:09:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T13:24:26.000Z (about 1 year ago)
- Last Synced: 2023-10-19T16:51:32.688Z (about 1 year ago)
- Topics: docker-compose, docker-file, dto, gateway, hibernate, java-11, lombok, mapstruct, maven, postman-collection, slf4j, spring-boot, spring-doc, swagger
- Language: Java
- Homepage:
- Size: 697 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shareit
> ShareIt - сервис, который помогает людям
> делиться вещами, чтобы сэкономить на их покупке,
> особенно если вещь нужна только на короткий срок.
> Пользователи могут арендовать вещи,
> закрыть доступ к ним на время аренды,
> а также оставлять запросы на добавление новых вещей,
> если таковой не нашлось на платформе.
> ShareIt способствует развитию экономики
> совместного использования и уменьшает
> негативное влияние на окружающую среду
> за счет более эффективного использования ресурсов.
## Оглавление
- [API проекта](#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. Склонируйте репозиторий на свой компьютер с помощью команды:
```bash
git clone https://github.com/BucketOnHead/java-shareit.git
```
2. Перейдите в директорию проекта:
```bash
cd java-shareit
```
3. Соберите проект с помощью Apache Maven:
```bash
mvn clean install
```
### Запуск
После установки проекта, вы можете запустить его с помощью команды:
```bash
sudo docker-compose up -d
```
## Технологический стек
- Java 11
- Spring Boot 2
- ORM: Hibernate, Spring Data JPA
- Apache Maven
- Docker: dockerfile, docker-compose
- Swagger: springdoc