From 6bbfe60daf71342e2a5e8d1f23737432c6ddcd71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20=C3=89pardaud?= Date: Tue, 28 Jan 2025 10:00:15 +0100 Subject: [PATCH] Updated README --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c0346d5..77c63be 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ 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: @@ -11,8 +21,20 @@ You can run your application in dev mode that enables live coding using: ./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