https://github.com/manolo/town-hall
Vaadin Builders Challenge Team 3 (Town Hall)
https://github.com/manolo/town-hall
Last synced: 4 months ago
JSON representation
Vaadin Builders Challenge Team 3 (Town Hall)
- Host: GitHub
- URL: https://github.com/manolo/town-hall
- Owner: manolo
- License: unlicense
- Created: 2023-04-12T07:09:18.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-12T19:07:22.000Z (about 2 years ago)
- Last Synced: 2025-02-18T11:54:35.485Z (4 months ago)
- Language: Java
- Size: 603 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Experiment a Town Hall App developed in Hilla + React
This project still a work in progress.
__NOTE__: If you want to experiment with SSO in google, you need to configure `src/main/resources/application.properties`
## Running the application
The project is a standard Maven project. To run it from the command line,
type `mvnw` (Windows), or `./mvnw` (Mac & Linux), then open
http://localhost:8080 in your browser.
You can also import the project to your IDE of choice as you would with any
Maven project.
## Deploying to Production
To create a production build, call `mvnw clean package -Pproduction` (Windows),
or `./mvnw clean package -Pproduction` (Mac & Linux).
This will build a JAR file with all the dependencies and front-end resources,
ready to be deployed. The file can be found in the `target` folder after the build completes.
Once the JAR file is built, you can run it using
`java -jar target/myapp-1.0-SNAPSHOT.jar` (NOTE, replace
`myapp-1.0-SNAPSHOT.jar` with the name of your jar).
## Docker
You need Docker installed in your computer and running
1. To create a docker image with the application run
```
docker build -t town-hall .
```
2. To run the app in your local execute
```
docker run -it -p 8080:8080 --rm town-hall:latest
```
3. Then you can access your app in http://localhost:8080
## Project structure
DirectoryDescription
frontend/Client-side source directory
index.htmlHTML template
index.tsFrontend
entrypoint, bootstraps a React application
routes.tsxReact Router routes definition
MainLayout.tsxMain
layout component, contains the navigation menu, uses
App Layout
views/UI view
components
themes/Custom
CSS styles
src/main/java/<groupId>/Server-side
source directory, contains the server-side Java views
Application.javaServer entry-point
## Useful links
- Read the documentation at [hilla.dev/docs](https://hilla.dev/docs/).
- Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/hilla) or join our [Discord channel](https://discord.gg/MYFq5RTbBn).
- Report issues, create pull requests in [GitHub](https://github.com/vaadin/hilla).