Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/allitov/news-api
API for news portals and services.
https://github.com/allitov/news-api
docker java maven postgresql spring-boot spring-security spring-web-mvc springdoc-openapi-ui testcontainers
Last synced: 20 days ago
JSON representation
API for news portals and services.
- Host: GitHub
- URL: https://github.com/allitov/news-api
- Owner: allitov
- Created: 2023-11-20T08:06:34.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-20T09:05:03.000Z (10 months ago)
- Last Synced: 2024-03-21T07:46:50.653Z (10 months ago)
- Topics: docker, java, maven, postgresql, spring-boot, spring-security, spring-web-mvc, springdoc-openapi-ui, testcontainers
- Language: Java
- Homepage:
- Size: 265 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# News API
**API for news portals and services.**
The application provides the ability to save and edit news and comments on them,
storing user data, as well as creating news categories.
## Running locally
### Clone the repository and move to the working directory
```shell
git clone https://github.com/allitov/news-api.git
cd news-api
```
### Run the application in default mode
```shell
docker-compose --file ./docker/docker-compose-default.yml up -d
```
##### Stop the application
```shell
docker-compose --project-name="news-api" down
```
#### Run the application in demonstration mode (contains entries in the database)
```shell
docker-compose --file ./docker/docker-compose-demo.yml up -d
```
##### Stop the application
```shell
docker-compose --project-name="news-api-demo" down
```
### Run application environment only
```shell
docker-compose --file ./docker/docker-compose-env.yml up -d
```
#### Stop the environment
```shell
docker-compose --project-name="news-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).