Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/melloware/quarkus-primereact
Quarkus REST Server + PrimeReact UI
https://github.com/melloware/quarkus-primereact
monorepo primereact quarkus typescript
Last synced: 3 months ago
JSON representation
Quarkus REST Server + PrimeReact UI
- Host: GitHub
- URL: https://github.com/melloware/quarkus-primereact
- Owner: melloware
- License: mit
- Created: 2022-07-31T12:51:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T11:32:21.000Z (5 months ago)
- Last Synced: 2024-09-17T21:42:29.812Z (5 months ago)
- Topics: monorepo, primereact, quarkus, typescript
- Language: TypeScript
- Homepage:
- Size: 14 MB
- Stars: 17
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Quarkus PrimeReact
[](https://opensource.org/licenses/MIT)
[](https://github.com/melloware/quarkus-monorepo/actions/workflows/build.yml)
[](https://github.com/quarkusio/quarkus)
**If you like this project, please consider supporting me ❤️**
[](https://github.com/sponsors/melloware)
[](https://www.paypal.me/mellowareinc)
This [monorepo](https://en.wikipedia.org/wiki/Monorepo) is a minimal CRUD service exposing a couple of endpoints over REST,
with a front-end based on React so you can play with it from your browser.
While the code is surprisingly simple, under the hood this is using:
- RESTEasy to expose the REST endpoints and documented with OpenAPI
- Hibernate ORM with Panache to perform the CRUD operations on the database
- PostgreSQL database; automatically starts an embedded DB
- [Liquibase](https://www.liquibase.com/) to automatically update database
- [Quinoa](https://github.com/quarkiverse/quarkus-quinoa) to handle allowing this monorepo to serve React and Java code
- [React + PrimeReact](https://primereact.org/) for a top notch user interface including lazy datatable
- [TanStack Query](https://tanstack.com/query/latest) for powerful asynchronous state management for TypeScript
- [Orval](https://orval.dev/) to generate TanStack Query client Typescript from OpenAPI definition
- [React Hook Forms](https://react-hook-form.com/) to validate user input data
## Requirements
To compile and run this demo you will need:
- JDK 17+
- Docker
In addition, you will need either a PostgreSQL database, or Docker to run one.
## Developing
### Live coding with Quarkus
The Maven Quarkus plugin provides a development mode that supports
live coding. To try this out:
```bash
$ ./mvnw quarkus:dev
```
Watch as it starts up a temporary PostreSQL database just for this session. In this mode you can make changes to the code and have the changes immediately applied, by just refreshing your browser.
> :bulb:
Hot reload works add a new REST endpoint and see it update in realtime. Try it!
Now open your web browser to http://localhost:8080/ to see it in action.
[](https://github.com/melloware/quarkus-monorepo)
## Building
### Run Quarkus in JVM mode
When you're done iterating in developer mode, you can run the application as a
conventional jar file.
First compile it:
```bash
$ ./mvnw package
```
Connection properties for the Agroal datasource are defined in the standard Quarkus configuration file,
`src/main/resources/application.properties`.
Then run it with:
```bash
$ java -jar ./target/quarkus-app/quarkus-run.jar
```
Navigate to:
> :bulb:
Have a look at how fast it boots. Or measure total native memory consumption...
### Run Quarkus as a native application
You can also create a native executable from this application without making any
source code changes. A native executable removes the dependency on the JVM:
everything needed to run the application on the target platform is included in
the executable, allowing the application to run with minimal resource overhead.
Compiling a native executable takes a bit longer, as GraalVM performs additional
steps to remove unnecessary codepaths. Use the `native` profile to compile a
native executable:
```bash
$ mvn -Pnative
```
After getting a cup of coffee, you'll be able to run this binary directly where ${version} is the current project version:
```bash
$ docker run -i --rm -p 8080:8080 melloware/quarkus-primereact:${version}
```
> :bulb:
Please brace yourself: don't choke on that fresh cup of coffee you just got. Now observe the time it took to boot, and remember: that time was mostly spent to generate the tables in your database and import the initial data.
## See it in your browser
Navigate to: