Skip to content

Commit 9592127

Browse files
committed
Milestone: Initial working SPA (Thymeleaf, HTMX, AlpineJS, and Daisy UI)
1 parent bc7c35b commit 9592127

14 files changed

Lines changed: 5728 additions & 35 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,3 +228,5 @@ Temporary Items
228228
###################
229229
**.zip
230230
htmlReport
231+
/node
232+
/node_modules

‎README.md‎

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,50 @@
1-
# Title
1+
# Beacon
22

3-
|| Description about the Project ||
3+
Beacon is a Spring Boot MVC web app scaffold that uses:
44

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
69

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.
811

9-
## Getting Started
12+
## Requirements
1013

11-
Required for running this:
14+
- Java 25
15+
- Apache Maven 3.9.16+ or the included Maven Wrapper
1216

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
1618

17-
## Building and Running
19+
### Unix/Linux/macOS
1820

19-
Follow the steps below to build and run Komet on your local machine:
21+
```bash
22+
./mvnw spring-boot:run
23+
```
2024

21-
1. Clone the repository from GitHub to your local machine
25+
### Windows
2226

23-
2. Change local directory to cloned repo location
27+
```bash
28+
./mvnw.cmd spring-boot:run
29+
```
2430

25-
3. Enter the following command to build the application:
31+
Open the app at [http://localhost:8080](http://localhost:8080).
2632

27-
Unix/Linux/OSX:
33+
## Build and test
2834

2935
```bash
30-
./mvnw clean install
36+
./mvnw clean test
3137
```
3238

33-
Windows:
39+
## Project structure
3440

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
3845

3946
## Issues and Contributions
47+
4048
Technical and non-technical issues can be reported to the [Issue Tracker](https://github.com/ikmdev/repo-seed/issues).
4149

4250
Contributions can be submitted via pull requests. Please check the [contribution guide](doc/how-to-contribute.md) for more details.

‎mvnw‎

Lines changed: 43 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎mvnw.cmd‎

Lines changed: 48 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)