https://github.com/e-motionai/products-service
Products management service of (e)motion.AI project.
https://github.com/e-motionai/products-service
backend docker kotlin quarkus-maven
Last synced: 2 months ago
JSON representation
Products management service of (e)motion.AI project.
- Host: GitHub
- URL: https://github.com/e-motionai/products-service
- Owner: E-MotionAI
- Created: 2025-01-24T23:48:03.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-13T23:09:29.000Z (about 1 year ago)
- Last Synced: 2025-05-19T01:13:10.104Z (about 1 year ago)
- Topics: backend, docker, kotlin, quarkus-maven
- Language: Kotlin
- Homepage:
- Size: 81.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# User Service
## Overview
The User Service is a Quarkus application designed to manage user-related operations. It is built using Kotlin and Java, and uses Maven for dependency management.
## Features
- User registration
- User authentication
- User profile management
- RESTful API endpoints
## Technologies
- **Languages**: Kotlin, Java
- **Frameworks**: Quarkus
- **Build Tool**: Maven
## Prerequisites
- JDK 11 or higher
- Maven 3.6.0 or higher
## Getting Started
### Clone the repository
```bash
git clone https://github.com/jcalopes/user_service.git
cd user_service
```
### Running the application in dev mode
You can run your application in dev mode that enables live coding using:
```bash
./mvnw quarkus:dev
```
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at .
### Packaging and running the application
The application can be packaged using:
```bash
./mvnw package
```
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory. Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.
The application is now runnable using:
```bash
java -jar target/quarkus-app/quarkus-run.jar
```
If you want to build an _über-jar_, execute the following command:
```bash
./mvnw package -Dquarkus.package.jar.type=uber-jar
```
The application, packaged as an _über-jar_, is now runnable using:
```bash
java -jar target/*-runner.jar
```
### Running Tests
```bash
./mvnw test
```
## API Endpoints
- **POST** `/api/v1/user` - Register a new user
- **GET** `/api/v1/user/{username}` - Get user details by username
- **PUT** `/api/v1/user` - Update user details
- **DELETE** `/api/v1/user` - Delete a user
## Accessing Swagger UI
You can access the Swagger UI by running the application and navigating to:
## Contributing
1. Fork the repository
2. Create a new branch (`git checkout -b feature-branch`)
3. Commit your changes (`git commit -m 'Add some feature'`)
4. Push to the branch (`git push origin feature-branch`)
5. Create a new Pull Request