Skip to content

Commit

Permalink
Add development instructions to readme. Closes #513
Browse files Browse the repository at this point in the history
  • Loading branch information
F43nd1r committed Mar 28, 2024
1 parent 1d7d488 commit ed9645f
Showing 1 changed file with 34 additions and 3 deletions.
37 changes: 34 additions & 3 deletions README.md
Expand Up @@ -17,29 +17,60 @@ See [Wiki Setup guide](https://github.com/F43nd1r/acra-backend/wiki/Setup-guide)
# Screenshots

###### Listing reports

![report list](screenshots/reports.png)

###### Statistics

![statistics](screenshots/statistics.png)

###### Proguard and Export Support

![admin tab](screenshots/admin.png)

###### Report Summary and Attachment Support

![report summary](screenshots/summary.png)

###### Full Report content

![report content](screenshots/details.png)

###### Dark Theme

![dark theme](screenshots/dark.png)

# Development

## Running locally

```shell
./gradlew bootRun
```

## Building release

### Jar

```shell
./gradlew bootJar -x test -Pvaadin.productionMode=true
```

### Docker Image

```shell
./gradlew bootJar -x test -Pvaadin.productionMode=true
docker build -t f43nd1r/acrarium:git acrarium
```

# License

All source code in this repository is licensed under the Apache License 2.0 (see [LICENSE](LICENSE))

# Credits

Thanks to
- [Mirza Zulfan](https://github.com/mirzazulfan) for creating the logo.
- [aptly-io](https://github.com/aptly-io) (Dutch), [Federico Iosue](https://github.com/federicoiosue) (Italian), [Astarivi](https://github.com/astarivi) (Spanish), [iisimpler](https://github.com/iisimpler) (Chinese) for contributing to localization.
Thanks to

- [Mirza Zulfan](https://github.com/mirzazulfan) for creating the logo.
- [aptly-io](https://github.com/aptly-io) (Dutch), [Federico Iosue](https://github.com/federicoiosue) (Italian), [Astarivi](https://github.com/astarivi) (
Spanish), [iisimpler](https://github.com/iisimpler) (Chinese) for contributing to localization.

0 comments on commit ed9645f

Please sign in to comment.