Skip to content

Commit babfe85

Browse files
committed
feat: add README
1 parent 4353ca1 commit babfe85

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Livechat
2+
3+
This repository refactors the archived [k8splay](https://github.com/h3nryc0ding/k8splay) to use [fluxcd](https://github.com/fluxcd/flux2) and [bitnami helm charts](https://github.com/bitnami/charts) as dependencies.
4+
5+
## Features
6+
7+
- [x] GraphQL API
8+
- [x] SSO Authentication
9+
- [x] WebSocket based live chat
10+
11+
### Backend
12+
13+
- [x] Reactive Spring Boot with WebFlux and Kotlin
14+
- [x] Persistence with R2DBC and MongoDB
15+
- [x] Authentication and Authorization using Keycloak and oAuth2
16+
- [x] GraphiQL available at `/graphiql`
17+
18+
To run the backend locally, you need to have Jave, Docker, and Docker Compose installed. Start the backend with:
19+
20+
```bash
21+
cd backend
22+
make dev
23+
```
24+
25+
### Frontend
26+
27+
- [x] SvelteKit
28+
- [x] ShadCN and TailwindCSS for styling
29+
- [x] Houdini GraphQL client for SSR
30+
- [x] Authenticated routes
31+
32+
To run the frontend locally, you need to have NodeJS installed. It also expects the backend to be running locally. Start the frontend with:
33+
34+
```bash
35+
cd frontend
36+
make dev
37+
```

0 commit comments

Comments
 (0)