🐛 Fix Docker configuration + add doc + remove gitpod configuration (#33)

Author: jeanphi-baconnais

.dockerignore

@@ -3,3 +3,4 @@
 !target/*-runner.jar
 !target/lib/*
 !target/quarkus-app/*
+!.gcloud-conf.json

.gitpod.yml

@@ -0,0 +1,14 @@
+FROM eclipse-temurin:25-jre
+
+ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en'
+
+# We make four distinct layers so if there are application changes the library layers can be re-used
+COPY target/quarkus-app/lib/ /deployments/lib/
+COPY target/quarkus-app/*.jar /deployments/
+COPY target/quarkus-app/app/ /deployments/app/
+COPY target/quarkus-app/quarkus/ /deployments/quarkus/
+
+EXPOSE 8080 8888
+ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
+ENV JAVA_APP_JAR="/deployments/quarkus-run.jar"
+ENTRYPOINT [ "/bin/sh", "-c", "java $JAVA_OPTS -jar $JAVA_APP_JAR" ]

.gitpod/Dockerfile

@@ -1,8 +1,9 @@
 # Opensource-statistiques 📊
 
 ![GitHub Release](https://img.shields.io/github/v/release/zenika-open-source/opensource-statistics)
-![Quarkus](https://img.shields.io/badge/Quarkus-3.12.1-4695EB?logo=quarkus)
-![Java](https://img.shields.io/badge/Java-17-ED8B00?logo=openjdk&logoColor=white)
+![Quarkus](https://img.shields.io/badge/Quarkus-3.31.2-4695EB?logo=quarkus)
+![Java](https://img.shields.io/badge/Java-25-ED8B00?logo=openjdk&logoColor=white)
+![Javelit](https://img.shields.io/badge/Javelit-0.86.0-70FF9A)
 
 🚧 This project is in progress ... 
 
@@ -16,7 +17,8 @@ Data could be used to find and list projects maintained or forked by Zenika Memb
 Using:
 - [Quarkus](https://quarkus.io/)
 - [Firestore](https://docs.quarkiverse.io/quarkus-google-cloud-services/) to save data
-- [GitHub actions](https://github.com/features/actions) as CICD - 🚧 not implemented
+- [GitHub actions](https://github.com/features/actions) as CICD - to be implemented
+- [Javelit](https://javelit.io) to display information
 
 ## 🌐 API 
 
@@ -27,16 +29,46 @@ Some resources are available but only the first is in progress :
 - `/contributions/` to get information about contributions from GCP database 🚧 not implemented
 - `/workflow/` to get data and save them on GCP database
 
+## 🎨 UI 
+
+An interface made with Javelit is available.
+- `http://localhost:8888` to access the Javelit dashboard
+
+![zenika-open-source-dashboard](./docs/images/zenika-open-source-dashboard.png)
+
+
 > 🎯 The last resource will be removed after implementing all features and will be replaced by schedules. 
 
 ## 📝 Setup 
 
 - You need a GitHub token you can generate on [this page](https://github.com/settings/tokens).
 - Create a `.env` file based on the `.env-example` file and set the token previously created. 
-- You have to create a `.gcloud-conf.json` to save service account (it's not the best option actually, this can be replaced by another configuration).
-- Run the application with `quarkus dev` if you have the [Quarkus CLI](https://quarkus.io/guides/cli-tooling) installed on your environment, or `mvn quarkus:dev`command.
+- Create a `.gcloud-conf.json` file in the root of the project containing your Google Cloud service account key. This is required for the application to authenticate with GCP services.
+- **Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable** to point to your key file. This is crucial for authentication in your local environment.
+  ```bash
+  export GOOGLE_APPLICATION_CREDENTIALS=$(pwd)/.gcloud-conf.json
+  ```
+- Run the application with `quarkus dev` if you have the Quarkus CLI installed on your environment, or `mvn quarkus:dev` command.
 - You can use Quarkus dev service for Firestore enabling this variable `quarkus.google.cloud.firestore.devservice.enabled` in application.properties file.
 
+## 🐳 Docker
+
+Start by building the image:
+
+```bash
+docker build -t zoss-dashboard .
+```
+
+Then run the container mapping the ports (8080 for API, 8888 for UI) and mounting the credentials:
+
+```bash
+docker run -it --rm \
+  -p 8080:8080 -p 8888:8888 \
+  -v "$(pwd)/.gcloud-conf.json:/etc/gcp/creds.json:ro" \
+  -e GOOGLE_APPLICATION_CREDENTIALS=/etc/gcp/creds.json \
+  zoss-dashboard
+```
+
 ## ✨Contribute 
 
 Anyone can contribute to this project. For the moment, please add your question or propose something in [a new issue](https://github.com/zenika-open-source/opensource-statistics/issues).

.idx/dev.nix

@@ -15,6 +15,7 @@
     <quarkus.platform.version>3.31.2</quarkus.platform.version>
     <surefire-plugin.version>3.2.5</surefire-plugin.version>
     <quarkus.google-cloud-services.version>2.20.1</quarkus.google-cloud-services.version>
+    <javelit-version>0.86.0</javelit-version>
   </properties>
 
   <dependencyManagement>
@@ -102,7 +103,7 @@
     <dependency>
       <groupId>io.javelit</groupId>
       <artifactId>javelit</artifactId>
-      <version>0.86.0</version>
+      <version>${javelit-version}</version>
     </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>

Dockerfile

@@ -19,14 +19,8 @@ public ContributionsRessources(FirestoreServices firestoreServices) {
         this.firestoreServices = firestoreServices;
     }
 
-    /**
-     * Get contributions for one member.
-     *
-     * @param memberId of the member requested
-     * @return
-     */
     @GET
-    @Path("/contributions/member/{memberId}")
+    @Path("/member/{memberId}")
     public Response getContributionsByMember(@PathParam("memberId") String memberId) throws DatabaseException {
         return Response.ok(firestoreServices.getContributionsForAMemberOrderByYear(memberId)).build();
     }