https://github.com/sultanbadri/spring-boot-user-settings

A Spring Boot app for CRUD operations on user settings, using PostgreSQL for data storage.
https://github.com/sultanbadri/spring-boot-user-settings

Last synced: about 4 hours ago
JSON representation

A Spring Boot app for CRUD operations on user settings, using PostgreSQL for data storage.

• Host: GitHub
• URL: https://github.com/sultanbadri/spring-boot-user-settings
• Owner: SultanBadri
• Created: 2024-06-10T00:16:15.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-06-22T20:48:45.000Z (5 months ago)
• Last Synced: 2024-06-23T09:55:53.546Z (5 months ago)
• Language: Kotlin
• Size: 58.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# spring-boot-user-settings

A simple Spring Boot application for managing user settings with PostgreSQL integration, providing CRUD operations through RESTful APIs.

## Getting Started

### Prerequisites

- Docker

- Docker Compose

- Java 21

- Gradle

Clone the repository:

```

git clone https://github.com/SultanBadri/spring-boot-user-settings.git

```

Navigate to the project directory:

```

cd spring-boot-user-settings

```

Create a `.env` file in the project root with the following content:

```

POSTGRES_DB=your_db

POSTGRES_USER=your_username

POSTGRES_PASSWORD=your_password

```

Build the application JAR:

```

./gradlew build

```

Build and start the application with Docker Compose:

```

docker-compose up --build

```

The application will be running on http://localhost:8080.

## OpenAPI Documentation

This project includes OpenAPI documentation for the available RESTful APIs. Once the application is running, you can access the API documentation at http://localhost:8080/swagger-ui.html.

The OpenAPI documentation provides a user-friendly interface to interact with the API endpoints and view detailed information about request and response formats.