Skip to content

Commit

Permalink
chore: recover readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lgdd committed Apr 16, 2024
1 parent 52471e2 commit 7c0233b
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 7c0233b

Please sign in to comment.