https://github.com/bsstudio/bss-web-admin-backend
BSS admin website backend service
https://github.com/bsstudio/bss-web-admin-backend
Last synced: about 2 months ago
JSON representation
BSS admin website backend service
- Host: GitHub
- URL: https://github.com/bsstudio/bss-web-admin-backend
- Owner: BSStudio
- License: gpl-3.0
- Created: 2022-01-01T19:30:19.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-22T06:12:49.000Z (about 2 months ago)
- Last Synced: 2026-04-22T08:25:48.124Z (about 2 months ago)
- Language: Kotlin
- Homepage: https://app.circleci.com/pipelines/github/BSStudio/bss-web-admin-backend
- Size: 3.1 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# BSS Web admin backend
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-admin-backend)
[](https://www.bestpractices.dev/projects/10965)
## Project structure
```mermaid
---
title: Project structure
---
classDiagram
direction TB
namespace server {
class src
class web
class operation
class service
class model
class data
class common
}
integration ..> client
client ..> operation
integration ..> data
web ..> operation
web ..> service
service ..> data
operation ..> model
model ..> common
data ..> common
service ..> model
src ..> web
```
> Note: client can only access operation, model, common. No business code
> Note: integration can only access client (with everything mentioned above) and data. No business
> code
## Development
### Pre-requisites
Download sdkman to manage java and gradle versions.
```shell
git clone git@github.com:BSStudio/bss-web-admin-backend.git
cd bss-web-admin-backend
sdk env install
```
### Lint
```shell
./gradlew spotlessCheck
```
### Apply lint
```shell
./gradlew spotlessApply
```
### Test
```shell
./gradlew test
```
### Integration test
```shell
docker compose up -d
./gradlew integrationTest
docker compose down
```
### Build
Docker:
```shell
docker build -t bss-web-admin-backend .
```
Gradle:
```shell
./gradlew build
```
### Run
Docker:
```shell
docker run bss-web-admin-backend
```
Docker compose:
```shell
docker compose up
```
This will start the app, database, and 3rd party mocks.
If you want to look at metrics
````shell
# Set your git not to commit changes to the default Grafana config
git update-index --skip-worktree docker/grafana/grafana.db
docker compose -profile metrics up
# If you want to commit changes to the default Grafana config
git update-index --no-skip-worktree docker/grafana/grafana.db
git add docker/grafana/grafana.db
git commit -m "Update Grafana config"
# Ignore logs again
git update-index --skip-worktree docker/grafana/grafana.db
````
Gradle:
```shell
./gradlew bootRun
```
## Developer docs
Please read the documentation for each module to understand the codebase.
- [buildSrc](buildSrc/README.md)
- [client](client/README.md)
- [integration](integration/README.md)
- [server](server/README.md)
- [client](server/client/README.md)
- [common](server/common/README.md)
- [data](server/data/README.md)
- [model](server/model/README.md)
- [operation](server/operation/README.md)
- [service](server/service/README.md)
- [web](server/web/README.md)