|
1 | | -# Title |
| 1 | +# Beacon |
2 | 2 |
|
3 | | -|| Description about the Project || |
| 3 | +Beacon is a Spring Boot MVC web app scaffold that uses: |
4 | 4 |
|
5 | | -### Team Ownership - Product Owner |
| 5 | +- **Thymeleaf** for server-side rendering |
| 6 | +- **HTMX** for partial page updates |
| 7 | +- **DaisyUI** for polished UI components |
| 8 | +- **AlpineJS** for lightweight client-side behavior |
6 | 9 |
|
7 | | -Team Ownership - Product Owner |
| 10 | +The starter includes a responsive top navigation, a hero section, an HTMX-loaded status card, and a styled footer. |
8 | 11 |
|
9 | | -## Getting Started |
| 12 | +## Requirements |
10 | 13 |
|
11 | | -Required for running this: |
| 14 | +- Java 25 |
| 15 | +- Apache Maven 3.9.16+ or the included Maven Wrapper |
12 | 16 |
|
13 | | -1. Download and install Java 24 (Azul) |
14 | | -2. Download and install Apache Maven 3.9.11 or later |
15 | | -3. Download and install Git |
| 17 | +## Run locally |
16 | 18 |
|
17 | | -## Building and Running |
| 19 | +### Unix/Linux/macOS |
18 | 20 |
|
19 | | -Follow the steps below to build and run Komet on your local machine: |
| 21 | +```bash |
| 22 | +./mvnw spring-boot:run |
| 23 | +``` |
20 | 24 |
|
21 | | -1. Clone the repository from GitHub to your local machine |
| 25 | +### Windows |
22 | 26 |
|
23 | | -2. Change local directory to cloned repo location |
| 27 | +```bash |
| 28 | +./mvnw.cmd spring-boot:run |
| 29 | +``` |
24 | 30 |
|
25 | | -3. Enter the following command to build the application: |
| 31 | +Open the app at [http://localhost:8080](http://localhost:8080). |
26 | 32 |
|
27 | | -Unix/Linux/OSX: |
| 33 | +## Build and test |
28 | 34 |
|
29 | 35 | ```bash |
30 | | -./mvnw clean install |
| 36 | +./mvnw clean test |
31 | 37 | ``` |
32 | 38 |
|
33 | | -Windows: |
| 39 | +## Project structure |
34 | 40 |
|
35 | | -```bash |
36 | | -./mvnw.cmd clean install |
37 | | -``` |
| 41 | +- `src/main/java` - Spring Boot application and MVC controller |
| 42 | +- `src/main/resources/templates` - Thymeleaf views and fragments |
| 43 | +- `src/main/resources/static` - Small custom CSS overrides |
| 44 | +- `src/test/java` - MVC tests for the home page and HTMX fragment |
38 | 45 |
|
39 | 46 | ## Issues and Contributions |
| 47 | + |
40 | 48 | Technical and non-technical issues can be reported to the [Issue Tracker](https://github.com/ikmdev/repo-seed/issues). |
41 | 49 |
|
42 | 50 | Contributions can be submitted via pull requests. Please check the [contribution guide](doc/how-to-contribute.md) for more details. |
|
0 commit comments