Skip to content

Commit 71a0577

Browse files
committed
Add README and CI workflow for build and test
1 parent ecfd722 commit 71a0577

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Feedback
2+
3+
A feedback collection service for JavaZone, built with Kotlin and Ktor.
4+
5+
## Prerequisites
6+
7+
- JDK 25
8+
- Docker (for running PostgreSQL locally and tests)
9+
10+
## Getting started
11+
12+
Start the database:
13+
14+
```bash
15+
docker compose up -d
16+
```
17+
18+
Run the application:
19+
20+
```bash
21+
./gradlew :core:run
22+
```
23+
24+
The server starts on `http://localhost:8080`.
25+
26+
## Configuration
27+
28+
Configuration is done via environment variables. See `.env.example` for available options.
29+
30+
## Testing
31+
32+
Tests use Testcontainers and require a running Docker daemon.
33+
34+
```bash
35+
./gradlew test
36+
```
37+
38+
## Building
39+
40+
Build a fat JAR for deployment:
41+
42+
```bash
43+
./gradlew :core:buildFatJar
44+
```
45+
46+
Build the Docker image:
47+
48+
```bash
49+
docker build -t feedback .
50+
```

0 commit comments

Comments
 (0)