Skip to content

Commit

Permalink
Merge pull request #20 from FroMage/readme
Browse files Browse the repository at this point in the history
Updated README
  • Loading branch information
FroMage authored Jan 29, 2025
2 parents 6af80ee + 6bbfe60 commit ac8b901
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,37 @@ This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

## Prerequisites

- Install a JDK
- Archive: https://jdk.java.net/23/
- Brew: https://formulae.brew.sh/formula/openjdk
- SDKMan: https://sdkman.io/jdks/#open
- Install a container system (any of the two)
- Docker: https://docs.docker.com/engine/install/
- Podman: https://podman.io/docs/installation

## Running the application in dev mode

You can run your application in dev mode that enables live coding using:
```shell script
./mvnw compile quarkus:dev
```

This will start by creating a user with username: 'user', password: 'user' and fetch the
production data and store it in a postgres dev service database started automatically.
### Fetching production data

By default, at startup, this will create a user with username: 'user', password: 'user' and fetch the
production data and store it in a postgres dev service database started automatically (this
will be started in a container in either docker or podman).

The default production data source can be configured in `src/main/resources/application.properties`:

```xml
%dev.dev-auto-setup.url=https://2024.rivieradev.fr/Serialiser/json
```

You can change this to point to other years such as 2025. This will not fetch users, nor speaker emails,
for confidentiality reasons. This only fetches data which is already public on our website.

## Packaging for production

Expand Down

0 comments on commit ac8b901

Please sign in to comment.