From 7c0233b7b93eebfe88433294754a36dbc0eb26c1 Mon Sep 17 00:00:00 2001 From: lgdd Date: Tue, 16 Apr 2024 16:54:25 +0200 Subject: [PATCH] chore: recover readme --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0f4657c --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Liferay Starter + +Quickly generate & download your Liferay workspace. Inspired by [start.spring.io](https://start.spring.io/) +and [code.quarkus.io](https://code.quarkus.io/). + +![preview](https://github.com/lgdd/doc-assets/blob/main/liferay-starter/preview.jpg?raw=true) + +## Try it locally + +Using [Docker](https://hub.docker.com/repository/docker/lgdd/liferay-starter): + +```shell +docker run -it --rm -p 8000:8000 lgdd/liferay-starter +# or +docker run -it --rm -p 8000:8000 lgdd/liferay-starter:latest-jvm +``` + +> The default image and tag `lgdd/liferay-starter:latest` is a container image including a native executable instead of +> a jar. See: https://quarkus.io/guides/building-native-image. + +Once the container is started, go to http://localhost:8000. + +Using this repo: + +``` +git clone git@github.com:lgdd/liferay-starter.git +cd liferay-starter +make dev +``` + +> Please refer to the [Makefile](Makefile) to see the complete list of available commands. + +Once the server is started, go to http://localhost:8000. + +If you want to work on the frontend, run `make devFront` and go to http://localhost:3000. + +## License + +[MIT](LICENSE)