https://github.com/markma512/blog-server
A Backend System for Personal Blog built with Spring Boot
https://github.com/markma512/blog-server
cicd docker mvc-architecture postgresql rest-api spring-boot tdd
Last synced: 3 months ago
JSON representation
A Backend System for Personal Blog built with Spring Boot
- Host: GitHub
- URL: https://github.com/markma512/blog-server
- Owner: MarkMa512
- Created: 2025-01-06T06:02:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-03T15:42:32.000Z (over 1 year ago)
- Last Synced: 2025-03-06T20:17:06.091Z (over 1 year ago)
- Topics: cicd, docker, mvc-architecture, postgresql, rest-api, spring-boot, tdd
- Language: Java
- Homepage: https://blogserver-3d7e486c7e82.herokuapp.com/
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Blog Server with Spring Boot
## Built with
1. Spring Boot
2. PostgreSQL
3. Docker
## Key Features
### REST API
- This project aims to implement a set of **RESTful API** for blog post management.
- Supporting essential **CRUD Operations**
- Create: Add new blog posts
**Localhost Testing:**
```
POST http://localhost:8080/api/posts
```
- Read: Fetch individual/all blog post
```
GET http://localhost:8080/api/posts
```
- Update: Modify existing blog posts
```
PUT http://localhost:8080/api/posts/{id}
```
- Delete: Remove blog posts from the database
```
DELETE http://localhost:8080/api/posts/{id}
```
The application is currently deployed on Heroku at: https://blogserver-3d7e486c7e82.herokuapp.com/
(for cost and security purposes it is usually placed under maintenance mode).
- Follows the best practice for REST API design, including proper use of
- HTTP Method
- HTTP Status code
- Request and Response Structure
For more details, please refer to [api/post.http](api/post.http)
### MVC Models: Model View Controller
- **Packaged by feature**: This project follows this convention for better encapsulation,
maintainability and clarity.
- Each feature (eg. post) is a package that contains its own domain model, controller, repository, and relevant
exceptions.
- Eg:
```
post/
- Post.java //Record: domain model for a blog post
- PostController.java //Class: handles HTTP requests and responses
- PostNotFoundException //Class: custom exception for missing posts
- PostRepository //Interface: data access logic using Spring Data JPA
```
### Test Driven Development
- Emphasizes **Test-Driven-Development(TDD)** for robust and reliable code.
#### Unit Test
- Unit Tests for `PostController`: [`PostControllerTest.java`](src/test/java/com/ningzhi/blog_server/post/PostControllerTest.java)
- Validates the behavior of the PostController in isolation.
- Ensures the correctness of the REST endpoints.
#### Integration Test
- Integration Test for `PostController`: [`PostControllerIntegrationTest.java`](src/test/java/com/ningzhi/blog_server/post/PostControllerIntegrationTest.java)
- Test the interaction between PostController, PostRepository and the Database.
- Utilizing In-memory H2 database for realistic testing.
- Verifies the complete workflow, from API calls to database operations.
#### Tools Used
- **JUnit**: For writing and running tests.
- **Mockito**: For mocking dependencies in unit tests.
- **Spring Boot Test**: For integration testing with embedded contexts.
### CI/CD
The CI/CD pipeline for this project is implemented using **GitHub Action** that automatically build, test, and
deployment workflows. Key features include:
#### Continuous Integration (CI):
- Automatically triggered on every push or pull request to the main branch.
- Executes build and test steps using Maven, ensuring the codebase remains functional and maintainable.
- Uploads build artifacts (JAR files) for further deployment stages.
#### Continuous Deployment (CD):
- It is currently successfully deployed on Heroku at: https://blogserver-3d7e486c7e82.herokuapp.com/
(for cost and security purposes it is usually placed under maintenance mode).
- Supports integration with deployment platforms like AWS Elastic Beanstalk, enabling automated deployments of the
built application.
- Containerized deployment with Docker can also be incorporated for platform independence.
This setup ensures rapid feedback on code changes and streamlines the deployment process, promoting a seamless
development lifecycle.
For the details for the GitHub Action workflow, please refer to [.github/workflows/maven.yml](.github/workflows/maven.yml)
### Version Control
A structured approach to version control is employed to maintain consistency and clarity in the project’s history.
The following commit message labels are used to categorize changes:
| Label | Stand for | Description | Example |
|--------|---------------|--------------------------------------------------|-------------------------------------------------|
| `feat` | feature | Introduces a new feature or enhancement. | `feat: implement API for fetching posts` |
| `doc` | documentation | Adds or updates documentation (e.g., README). | `doc: update README with CI/CD details` |
| `dep` | dependency | Updates dependencies (e.g., Maven, Docker, etc). | `dep: upgrade Spring Boot to version x.y.z` |
| `test` | test | Adds or modifies tests (unit, integration, etc). | `test: add integration test for PostController` |
By adhering to these labels, the project history remains organized, making it easier for collaborators to track and
understand changes over time.