Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beaverhouse/announcement-server-java
An announcement server powered by Spring Boot
https://github.com/beaverhouse/announcement-server-java
announcement api-rest java spring-boot
Last synced: 27 days ago
JSON representation
An announcement server powered by Spring Boot
- Host: GitHub
- URL: https://github.com/beaverhouse/announcement-server-java
- Owner: BeaverHouse
- License: mit
- Created: 2024-11-24T13:02:56.000Z (28 days ago)
- Default Branch: main
- Last Pushed: 2024-11-24T13:16:52.000Z (28 days ago)
- Last Synced: 2024-11-24T14:22:09.547Z (28 days ago)
- Topics: announcement, api-rest, java, spring-boot
- Language: Java
- Homepage:
- Size: 81.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
An announcement server powered by Spring Boot
Bug Report
|
Request
## Overview
An announcement server built with Spring Boot and JPA.
Provides RESTful APIs and uses the Oracle Autonomous Database.
## Prerequisites
1. You need to have Java 17 installed.
2. You need to set environment variables in `application.properties` file.
```txt
spring.datasource.url="jdbc-url"
spring.datasource.username="username"
spring.datasource.password="password"
```
## Run in the local environment
**Run the application**
```
./gradlew bootRun
```
**Build the project**
```
./gradlew build
```
## Swagger UI
After running the server, Swagger UI is available at:
```
http://localhost:8080/swagger-ui.html
```
## Deploy the project
1. Move the built `.jar` file to the target VM or container.
2. The script is in the `scripts` folder.
3. Run the application and expose it via reverse proxy, for example, NGINX.
## Contributing
See the [CONTRIBUTING.md](./CONTRIBUTING.md).
[Spring Boot]: https://spring.io/projects/spring-boot
[Spring Data JPA]: https://spring.io/projects/spring-data-jpa
[MySQL]: https://www.mysql.com/
[Gradle]: https://gradle.org/