Skip to content

Commit 957fef9

Browse files
authored
Update README.md
1 parent 30366cb commit 957fef9

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,69 @@
11
[![Only Tests](https://github.com/P4piJoke/blog-rest-api/actions/workflows/only-tests.yml/badge.svg)](https://github.com/P4piJoke/blog-rest-api/actions/workflows/only-tests.yml)
22
[![Deploy](https://github.com/P4piJoke/blog-rest-api/actions/workflows/deploy.yml/badge.svg)](https://github.com/P4piJoke/blog-rest-api/actions/workflows/deploy.yml)
3+
4+
# Blog REST API
5+
6+
The Blog REST API is a web service that allows users to create, manage, and interact with blog content easily. It includes endpoints for essential entities such as Post, Category, and Comment. Users can create categorized posts for organized content management and engage in discussions by commenting on posts. Role-based access control allows administrators to regulate user permissions, ensuring security and integrity. The API's RESTful design promotes easy integration into diverse platforms, enhancing the blogging experience for both creators and readers.
7+
8+
9+
10+
11+
## Authors
12+
13+
- [@Danylo Papizhuk](https://github.com/P4piJoke)
14+
15+
16+
## Tech Stack
17+
18+
**Client:** Not implemented
19+
20+
**Server:** Java 17, Spring Boot 3
21+
22+
**Database:** MySQL
23+
24+
**Branching strategy:** GitHub flow
25+
26+
27+
## Run Locally
28+
29+
Firstly, create database
30+
31+
```bash
32+
create database myblog;
33+
```
34+
35+
Clone the project
36+
37+
```bash
38+
git clone https://github.com/P4piJoke/blog-rest-api.git
39+
```
40+
41+
Go to the project directory
42+
43+
```bash
44+
cd blog-rest-api
45+
```
46+
47+
Install dependencies
48+
49+
```bash
50+
./mvnw clean install
51+
```
52+
53+
Start the server
54+
55+
```bash
56+
./mvnw spring-boot:run
57+
```
58+
59+
60+
## API Reference
61+
62+
#### Get Swagger documentation
63+
64+
```http
65+
GET /swagger-ui/index.html
66+
```
67+
68+
#### Other detailed information provided in Swagger documentation
69+

0 commit comments

Comments
 (0)