Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daniellaera/spring-blog-app
Spring Java Basic Blog App
https://github.com/daniellaera/spring-blog-app
docker docker-compose flyio flyway flyway-migrations jacoco postgresql rest-api spring spring-boot spring-docker spring-mvc testcontainers
Last synced: 9 days ago
JSON representation
Spring Java Basic Blog App
- Host: GitHub
- URL: https://github.com/daniellaera/spring-blog-app
- Owner: daniellaera
- License: mit
- Created: 2024-10-31T15:58:44.000Z (17 days ago)
- Default Branch: main
- Last Pushed: 2024-11-07T17:56:34.000Z (9 days ago)
- Last Synced: 2024-11-07T18:24:23.060Z (9 days ago)
- Topics: docker, docker-compose, flyio, flyway, flyway-migrations, jacoco, postgresql, rest-api, spring, spring-boot, spring-docker, spring-mvc, testcontainers
- Language: Java
- Homepage: https://blog-app-frontend.fly.dev/
- Size: 211 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spring Blog Application
[](https://github.com/daniellaera/spring-blog-app/actions/workflows/main.yml)
This Spring Boot application serves as a blog platform, allowing users to create, read, update, and delete blog posts. The user can also comment each post.
> Go on that URL as example *http://blog-app-black-pine-3535.fly.dev/api/v3/post* and you will see the list of posts
```json
[
{
"title": "Title 1",
"content": "Content 1",
"comments": [
{
"text": "comment 1"
}
]
},
{
"title": "Title 2",
"content": "Content 2",
"comments": [
{
"text": "comment 2"
}
]
},
{
"title": "Title 3",
"content": "Content 3",
"comments": [
{
"text": "comment 3"
}
]
}
]
```
## Table of Contents
- [Project Setup](#project-setup)
- [Technologies Used](#technologies-used)
- [Running the Application](#running-the-application)
- [Configuration](#configuration)
- [Building the Application](#building-the-application)
- [Endpoints](#endpoints)
- [Testing](#testing)
- [Deployment](#deployment)
## Project Setup
1. **Clone Repository**
```bash
git clone https://github.com/daniellaera/spring-blog-app.git
cd spring-blog-app
```
## Deployment Configuration
1. **Set Up Environment Variables**
Configure the following environment variables in your GitHub Actions workflow file (`.yml`), in the deployment service's settings, or in the repository's secrets section:
- `DATABASE_URL`: The URL for your database connection (e.g., `jdbc:postgresql://:/` for PostgreSQL).
- `DATABASE_USERNAME`: The username for your database.
- `DATABASE_PASSWORD`: The password for your database.
### Example for GitHub Actions
You can set these environment variables as repository secrets in GitHub, and then reference them in your workflow file:
```yaml
env:
DATABASE_URL: ${{ secrets.DATABASE_URL }}
DATABASE_USERNAME: ${{ secrets.DATABASE_USERNAME }}
DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
## Technologies Used
- **Java** and **Spring Boot** for backend development
- **PostgreSQL** as the relational database
- **Flyway** for database migrations
- **JUnit** and **Mockito** for unit and integration testing
- **GitHub Actions** for CI/CD pipeline
## Running the Application
1. **Run the application locally** with:
```bash
./mvnw spring-boot:run
```
2. **Run with the dev profile to load configuration from application-dev.yml** with:
```bash
./mvnw spring-boot:run -Dspring-boot.run.profiles=dev
```
3. **Access the application** at `http://localhost:8080`
## Configuration
The application settings are primarily managed through `application.yml` with environment-specific values for:
```yaml
spring:
datasource:
url: ${DATABASE_URL}
username: ${DATABASE_USERNAME}
password: ${DATABASE_PASSWORD}
driver-class-name: org.postgresql.Driver
jpa:
hibernate:
ddl-auto: none
flyway:
enabled: true
```
## Building the Application
To build the application and create an executable JAR file:
```bash
./mvnw clean package
```
## Endpoints
### Post Endpoints
- `GET /api/v3/post` - Retrieves all blog posts
- `GET /api/v3/post/{id}` - Retrieves a specific post by ID
- `POST /api/v3/post` - Create new post
- `DELETE /api/v3/post/{id}` - Delete a specific post by ID
### Comment Endpoints
- `GET /api/v3/{postId}/comments` - Retrieves all comments by postId
- `POST /api/v3/comment/{postId}` - Create new comment on specific postId
- `PATCH /api/v3/comment/{commentId}` - Update comment by ID
## Testing
Run tests with:
```bash
./mvnw test
```
The application includes unit tests for service layers and integration tests for the repository layer, ensuring data consistency and business logic reliability.
## Deployment
The application is configured to deploy using **Fly.io** via GitHub Actions. Ensure that the following GitHub Secrets are set for the deployment pipeline:
- `FLY_API_TOKEN`
- `DATABASE_URL`
- `DATABASE_USERNAME`
- `DATABASE_PASSWORD`
## Flyway Migrations
This SQL file, located in `src/main/resources/db/migration`, is processed by Flyway on startup if the database is missing this migration. It includes the initial table definitions and some sample data for testing:
`V1__init.sql`
```sql
-- Create post table
CREATE TABLE post (
id SERIAL PRIMARY KEY,
title VARCHAR(255),
content TEXT
);
-- Create comment table with foreign key to post table
CREATE TABLE comment (
id SERIAL PRIMARY KEY,
text TEXT,
post_id BIGINT,
FOREIGN KEY (post_id) REFERENCES post(id)
);
-- Insert initial data into post table
INSERT INTO post (title, content)
VALUES ('Title 1', 'Content 1'),
('Title 2', 'Content 2'),
('Title 3', 'Content 3'),
('Title 4', 'Content 4');
-- Insert initial data into comment table
INSERT INTO comment (text, post_id)
VALUES ('comment 1', 1),
('comment 2', 2),
('comment 3', 3);
```
> *Tip: For safe versioning, avoid modifying applied migration files like `V1__init.sql`. Instead, create new migration files (e.g., `V2__add_column.sql`) for schema updates.*