https://github.com/allitov/books-api
API for books services.
https://github.com/allitov/books-api
docker java maven postgres redis spring-boot spring-web-mvc
Last synced: 2 months ago
JSON representation
API for books services.
- Host: GitHub
- URL: https://github.com/allitov/books-api
- Owner: allitov
- Created: 2024-01-06T14:55:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-26T13:07:05.000Z (over 1 year ago)
- Last Synced: 2025-02-14T12:17:03.660Z (4 months ago)
- Topics: docker, java, maven, postgres, redis, spring-boot, spring-web-mvc
- Language: Java
- Homepage:
- Size: 112 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Books API
**API for books services.**
The application provides opportunities to create
and save data about books and their categories.
## Running locally
### Cloning the repository and moving to the working directory
```shell
git clone https://github.com/allitov/books-api.git
cd books-api
```
### Run the application in default mode
```shell
docker-compose --file ./docker/docker-compose-default.yaml up -d
```
#### Stop the application
```shell
docker-compose --project-name="books-api" down
```
### Run the application in demonstration mode (Contains entries in the database)
```shell
docker-compose --file ./docker/docker-compose-demo.yaml up -d
```
#### Stop the application
```shell
docker-compose --project-name="books-api-demo" down
```
### Run application environment only
```shell
docker-compose --file ./docker/docker-compose-env.yaml up -d
```
#### Stop the environment
```shell
docker-compose --project-name="books-api-env" down
```
## Documentation
To familiarize yourself with the application's API and see example queries,
you can refer to the [interactive Swagger documentation](http://localhost:8080/swagger-ui/index.html)
(available only after launching the application).