Skip to content

Commit

Permalink
fix: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hotungkhanh authored Sep 25, 2024
1 parent 34bd8d6 commit 424a405
Showing 1 changed file with 21 additions and 24 deletions.
45 changes: 21 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,7 @@
# jetedge
# Jet Edge
## How to run the app
### Running the backend
Move into the backend folder with:
`cd backend`

Package the project as a JAR file with (only needs to be done once):
`./mvnw package`

Build the Docker image with (only needs to be done once):
`docker build -f src/main/docker/Dockerfile.jvm -t quarkus/backend-jvm .`

Run the container with:
`docker run -i --rm -p 8080:8080 quarkus/backend-jvm`

This will spin up a container for the Quarkus backend ONLY.

Access backend via:
`http://localhost:8080/`

Test by checking whether `http://localhost:8080/hello` gets a message from the backend.

### Running the frontend
No container for frontend.

Move into the frontend folder with:
`cd frontend`

Expand All @@ -32,5 +11,23 @@ Install all the packages with (only needs to be done once):
Run in development mode with:
`npm run dev`

Access frontend via:
`http://localhost:3000/`
Build for production with:
`npm run build`

Run in production mode:
`npm run preview`

<br/>

### Running the backend
Move into the backend folder with:
`cd backend`

Run in development mode with:
`./mvnw compile quarkus:dev`

Package the project as a JAR file with (only needs to be done once):
`./mvnw package`

Run in production mode:
`java -jar target/quarkus-app/quarkus-run.jar`

0 comments on commit 424a405

Please sign in to comment.